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 All Attributes with Cluster Mapping
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/get_cluster_attributes \
--header 'Authorization: <api-key>'[
{
"attribute": "<string>",
"cluster": "<string>"
}
]Metrics
List All Attributes with Cluster Mapping
Provides a complete mapping of every detailed attribute to its parent cluster th
eme, showing the granular details that compose each high-level perception.
Clusters group similar attributes together. For example, the
'Comfort' cluster might contain attributes like 'soft', 'cushioned', 'ergonomic', 'cozy'. This endpoint lists all these detailed attributes and shows which cluster each belongs to. Essential for understanding the detailed components that make up each theme.
**When to use:** User wants to see detailed attributes within a cluster, understand what specific terms compose each theme, explore the granular data behind cluster aggregations, or map detailed mentions to high-level themes.
**Common user queries:**
- "What attributes are in the comfort cluster?"
- "Show me all the detailed pros attributes"
- "List the specific mentions grouped under each theme"
- "What detailed terms make up the quality cluster?"
- "Get attribute-to-cluster mapping"
**Returns:** Array of objects with attribute names and their associated cluster.
Example: [{"attribute": "soft", "cluster": "Comfortable"}, {"attribute": "cushioned",
"cluster": "Comfortable"}, {"attribute": "fast", "cluster": "Sporty"}]
Required permission: `read:analysis`.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
metrics
/
brand_perception
/
get_cluster_attributes
List All Attributes with Cluster Mapping
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/get_cluster_attributes \
--header 'Authorization: <api-key>'[
{
"attribute": "<string>",
"cluster": "<string>"
}
]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
Filter by one specific cluster group.
Available options:
all_cons, all_pros Available options:
csv, json ⌘I