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/mention_rate_and_average_position \
--header 'Authorization: <api-key>'[
{
"insight_title": "<string>",
"insight_description": "<string>"
}
]AI Insights: Complete Brand Awareness Profile
Returns AI-generated insights combining mention frequency and ranking data, providing holistic brand awareness analysis.
This endpoint analyzes both metrics together and generates insights like “Nike achieves both high frequency (85%) and top position (1.2), indicating market leadership, while Brand X has decent frequency (60%) but poor position (4.5), suggesting quality perception issues.” Identifies balanced performers, frequency-position gaps, and strategic opportunities.
When to use: User wants comprehensive awareness insights, needs combined metric interpretation, identifies balanced vs unbalanced performance, or requires holistic strategic recommendations.
Common user queries:
- “Generate complete awareness insights”
- “Explain overall brand performance”
- “Which brands excel in both metrics?”
- “Summarize combined awareness patterns”
- “What’s the full awareness picture?”
- “Show comprehensive insights”
Returns: Array of insight objects interpreting combined awareness metrics 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/mention_rate_and_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.