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
Hierarchical Perception Tree View
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree \
--header 'Authorization: <api-key>'{
"name": "<string>",
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123
}
]
}
]
}
]
}
]
}Metrics
Hierarchical Perception Tree View
Provides a complete hierarchical tree structure showing clusters → attributes →
brands → sources, with mention counts at each level.
This endpoint returns a nested data structure perfect for visualization,
showing how perception flows from high-level themes (clusters) down through specific attributes, to which brands are associated with each attribute, and which AI sources mentioned them. The tree includes mention counts, making it easy to see volume and importance at each level. Ideal for comprehensive perception analysis and creating sunburst or tree visualizations.
**When to use:** User wants a complete hierarchical view of perception data, needs data structured for tree visualizations, wants to explore perception from themes down to specific brand mentions, or requires full detail with counts at every level.
**Common user queries:**
- "Show me the complete perception hierarchy"
- "Get the full cluster breakdown with brands"
- "I need hierarchical data for visualization"
- "Show clusters, attributes, and brands in a tree"
- "Get the nested structure of pros and cons"
- "What's the full breakdown from themes to mentions?"
**Returns:** Hierarchical tree object with nested children and mention counts.
Example: {"name": "pros", "children": [{"name": "Comfortable", "value": 450, "children": [{"name": "soft",
"value": 200, "children": [{"name": "Nike", "value": 120}]}]}]}
Required permission: `read:analysis`.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
metrics
/
brand_perception
/
attributes_hierarchy_tree
Hierarchical Perception Tree View
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree \
--header 'Authorization: <api-key>'{
"name": "<string>",
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123,
"children": [
{
"name": "<string>",
"value": 123
}
]
}
]
}
]
}
]
}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 brand.
Filter by a list of brands. Values should be comma separated, without brackets or spaces
Filter by a list of clusters. Values should be comma separated, without brackets or spaces
Filter by one specific cluster group.
Available options:
all_cons, all_pros 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 clusters and attributes to English. Defaults to false.
⌘I