Core API
- GETAI-Generated Strategic Insights
- GETAI Insights: Brand Ranking Patterns
- GETAI Insights: Brand Awareness Levels
- GETAI Insights: Complete Brand Awareness Profile
- GETAI Insights: Brand Awareness Trends
- GETAI Insights: Market Dominance Patterns
- GETAI Insights: Platform-Specific Market Share
- GETAI Insights: Market Share Evolution
- GETAI Insights: Brand Attribute Scores
- GETAI Insights: Theme Breakdown Structure
- GETAI Insights: Brand Themes Across AI Models
- GETAI Insights: Brand Strengths/Weaknesses
Search API
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/average_position \
--header 'Authorization: <api-key>'[
{
"insight_title": "<string>",
"insight_description": "<string>"
}
]AI Insights: Brand Ranking Patterns
Returns AI-generated insights about brand ranking positions, explaining which brands consistently appear first vs last in AI recommendations.
This endpoint analyzes average position data and generates insights like “Nike holds the top position at 1.2, significantly ahead of Adidas at 2.8, indicating strong top-of-mind awareness.” Identifies ranking leaders, laggards, and competitive gaps in recommendation order.
When to use: User wants interpreted ranking insights, needs to understand position patterns, identifies top-ranked brands, or requires strategic recommendations based on position data.
Common user queries:
- “Generate insights on brand rankings”
- “Explain which brands rank highest”
- “What do the position numbers mean?”
- “Summarize competitive ranking patterns”
- “Which brand dominates recommendations?”
- “Show ranking insights”
Returns: Array of insight objects interpreting position data with strategic implications.
Current model in use: gpt-4o-mini.
Required permission: read:analysis
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/average_position \
--header 'Authorization: <api-key>'[
{
"insight_title": "<string>",
"insight_description": "<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.