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
Brand Ratings on Specific Attributes
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_guided_sentiments/average_attribute_rating \
--header 'Authorization: <api-key>'[
[
{
"brand": "Salomon",
"attribute": "comfort",
"average_rating": "5.33"
},
{
"brand": "Hoka",
"attribute": "comfort",
"average_rating": "5.67"
},
{
"brand": "Adidas",
"attribute": "comfort",
"average_rating": "7.00"
},
{
"brand": "Hoka",
"attribute": "price",
"average_rating": "7.00"
},
{
"brand": "Nike",
"attribute": "price",
"average_rating": "7.50"
},
{
"brand": "Adidas",
"attribute": "price",
"average_rating": "8.00"
},
{
"brand": "Nike",
"attribute": "comfort",
"average_rating": "8.00"
}
]
]Metrics
Brand Ratings on Specific Attributes
Shows how AI models rate each brand on specific attributes like price, quality,
comfort, durability, etc., revealing brand strengths and weaknesses.
This endpoint returns AI-generated ratings (typically 0-10 scale)
for each brand on configured attributes. Nike might score 9/10 on "style" but 4/10 on "price", revealing perception gaps. Perfect for understanding competitive positioning, identifying brand strengths to emphasize, and weaknesses to address in messaging.
**When to use:** User wants to compare brands on specific attributes, identify strengths and weaknesses, understand perception on dimensions like price/quality/comfort, create positioning matrices, or find competitive advantages.
**Common user queries:**
- "How is Nike rated on comfort?"
- "Compare brand ratings on price"
- "What are each brand's strengths and weaknesses?"
- "Show attribute scores for all brands"
- "Which brand scores highest on quality?"
- "Get ratings breakdown by attribute"
**Returns:** Array with brand, attribute, and average rating scores.
Example: [{"brand": "Nike", "attribute": "comfort", "average_rating": "8.00"}, {"brand": "Nike",
"attribute": "price", "average_rating": "7.50"}]
Required permission: `read:analysis`.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
metrics
/
brand_guided_sentiments
/
average_attribute_rating
Brand Ratings on Specific Attributes
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_guided_sentiments/average_attribute_rating \
--header 'Authorization: <api-key>'[
[
{
"brand": "Salomon",
"attribute": "comfort",
"average_rating": "5.33"
},
{
"brand": "Hoka",
"attribute": "comfort",
"average_rating": "5.67"
},
{
"brand": "Adidas",
"attribute": "comfort",
"average_rating": "7.00"
},
{
"brand": "Hoka",
"attribute": "price",
"average_rating": "7.00"
},
{
"brand": "Nike",
"attribute": "price",
"average_rating": "7.50"
},
{
"brand": "Adidas",
"attribute": "price",
"average_rating": "8.00"
},
{
"brand": "Nike",
"attribute": "comfort",
"average_rating": "8.00"
}
]
]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 attribute.
Filter by a list of attributes. Values should be comma separated, without brackets or spaces
Filter by one specific brand.
Filter by a list of brands. Values should be comma separated, without brackets or spaces
Filter by a collection date being equal to the specified date. YYYY-MM-DD format
Filter by a collection date being greater than the specified date. YYYY-MM-DD format
Filter by a collection date being greater than or equal the specified date. YYYY-MM-DD format
Filter by a collection date being less than the specified date. YYYY-MM-DD format
Filter by a collection date being less than or equal the specified date. YYYY-MM-DD format
Filter by one specific country.
Filter by a list of countries. Values should be comma separated, without brackets or spaces
Available options:
csv, json Filter by one specific persona.
Filter by a list of personas. Values should be comma separated, without brackets or spaces
Filter by one specific source.
Available options:
claude-3-5-sonnet, claude-4-5-sonnet, claude-4-6-sonnet, claude-4-sonnet, deepseek-chat, deepseek-reasoner, gemini-1.5-pro, gemini-2.0-flash, gemini-2.5-flash, gemini-2.5-flash-grounded, gemini-2.5-flash-lite, gemini-3-flash-preview, google-ai-mode, gpt-3.5-turbo, gpt-4-turbo, gpt-4o, gpt-4o-mini-search, gpt-5, gpt-5.2, gpt-5.4-mini, meta-llama-3.1-70B-instruct-turbo, meta-llama-3.2-70B-instruct-turbo, meta-llama-3.3-70B-instruct-turbo, meta-llama-4-maverick, mistral-7B-instruct, perplexity-sonar, rufus Filter by a list of sources. Values should be comma separated, without brackets or spaces
Available options:
claude-3-5-sonnet, claude-4-5-sonnet, claude-4-6-sonnet, claude-4-sonnet, deepseek-chat, deepseek-reasoner, gemini-1.5-pro, gemini-2.0-flash, gemini-2.5-flash, gemini-2.5-flash-grounded, gemini-2.5-flash-lite, gemini-3-flash-preview, google-ai-mode, gpt-3.5-turbo, gpt-4-turbo, gpt-4o, gpt-4o-mini-search, gpt-5, gpt-5.2, gpt-5.4-mini, meta-llama-3.1-70B-instruct-turbo, meta-llama-3.2-70B-instruct-turbo, meta-llama-3.3-70B-instruct-turbo, meta-llama-4-maverick, mistral-7B-instruct, perplexity-sonar, rufus If true, translates attributes to English. Defaults to false.
⌘I