Core API
- GETBrand Ranking Positions
- GETOverall Brand Awareness Score
- GETBrand Awareness Score Evolution
- GETBrand Mention Frequency
- GETCombined Brand Awareness Metrics
- GETBrand Mention Trends Over Time
- GETBrand Market Share Metric
- GETBrand Market Share by AI Model
- GETMarket Share Trends Over Time
- GETBrand Ratings on Specific Attributes
- GETHierarchical Perception Tree View
- GETBrand Perception by LLM Source
- GETBrand Ownership of Each Theme
- GETList Pros and Cons Cluster Groups
- GETOverall Cluster Share Distribution
- GETCluster Distribution Per Brand
- GETList All Attributes with Cluster Mapping
- GETBrand Perception Raw Pros And Cons
- GETOverall Source Authority Score
- GETSource Authority by AI Model
- GETComplete Source Authority Metrics
- GETSource Domain Ranking Positions
- GETSource Citation Frequency
- GETSource Citation Counts
- GETTopic-Specific Source Authority Scores
- GETTopic-Specific Source Authority by AI Model
- GETComplete Source Metrics by Topic
- GETSource Rankings for Specific Topics
- GETSource Citation Frequency by Topic
- GETSource Citation Counts by Topic
- GETAvailable AI Models List
- GETAll Information Sources
- GETComprehensive Domain Influence Breakdown
- GETTop and Bottom Reddit Communities
- GETDomain Influence Rankings
- GETDomain Influence Trends Over Time
- GETIndividual URL Performance Metrics
- GETCitation Rates by Platform Category
- GETSocial Media Sources with Context
- GETOverall Brand Performance Score
- GETBrand Performance by Market/Country
- GETBrand Performance by Target Persona
- GETBrand Performance by AI Model
- GETAudience Age Demographics
- GETAudience Geographic Type Demographics
- GETAvailable Audience Data Dates
- GETAudience Price Sensitivity
- GETAudience Gender Demographics
- GETGoogle Ads Targeting Categories
- GETAudience Household Demographics
- GETComplete Audience Segment Profiles
- GETDetailed Asset Performance Metrics
- GETAll Asset Evaluations Summary
- GETReddit insights
Search API
List Pros and Cons Cluster Groups
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/cluster_groups \
--header 'Authorization: <api-key>'[
{
"cluster_group": "all_cons",
"clusters": [
"quality",
"price",
"reach"
]
},
{
"cluster_group": "all_pros",
"clusters": [
"comfortable",
"sporty",
"style"
]
}
]Metrics
List Pros and Cons Cluster Groups
Lists all available cluster groups (themes) for a brand analysis, showing both p
ositive (pros) and negative (cons) perception clusters.
Clusters are the main themes that emerge from brand mentions,
such as 'comfortable', 'expensive', 'durable', 'stylish'. This endpoint returns the names of all available clusters grouped by sentiment (pros vs cons). Use this as a starting point to understand what perception themes exist in the analysis before diving into detailed metrics.
**When to use:** User wants to see what clusters exist, explore available themes, understand the structure of pros and cons categories, or get cluster names before querying specific metrics.
**Common user queries:**
- "What are the pros and cons clusters for this analysis?"
- "List all available clusters"
- "Show me the themes"
- "What cluster groups exist?"
- "Get cluster names for Nike"
- "What are the strengths and weaknesses themes?"
**Returns:** Array of cluster groups with their cluster names.
Example: [{"cluster_group": "all_pros", "clusters": ["comfortable", "sporty", "style"]},
{"cluster_group": "all_cons", "clusters": ["expensive", "limited availability"]}]
Required permission: `read:analysis`.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
metrics
/
brand_perception
/
cluster_groups
List Pros and Cons Cluster Groups
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/cluster_groups \
--header 'Authorization: <api-key>'[
{
"cluster_group": "all_cons",
"clusters": [
"quality",
"price",
"reach"
]
},
{
"cluster_group": "all_pros",
"clusters": [
"comfortable",
"sporty",
"style"
]
}
]Documentation Index
Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
A UUID string identifying the analysis.
A UUID string identifying the organization.
A UUID string identifying the workspace.
Query Parameters
If true, translates clusters and attributes to English. Defaults to false.
⌘I