get_overview
Get a quick cockpit overview: key counts (questions, answers, competitors, sources), global performance scores with trend vs previous period, and last monitoring date.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (default: 30) |
Returns
| Field | Description |
|---|
counts | Key metrics: questions, answers, competitors, sources, selfMentions, socialCitations, shoppingInsights, localBusinesses |
scores | Current period: mentionRate, sourceRate, shareOfVoice, sentiment |
previousPeriodScores | Same metrics for the previous period (for trend comparison) |
lastMonitoringDate | Date of the most recent AI response |
Use get_overview as the first call after list_brands to get a quick snapshot of brand health before diving into specific tools.
OAuth Scope
Requires: read:brands
Get e-commerce visibility in AI shopping results: stores that mention your products, competitor products, ratings, and opportunities.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (default: 30) |
limit | number | No | Max items to return (default: 10) |
Returns
| Field | Description |
|---|
summary | Total products, stores, mentions, avg rating |
topStores[] | Stores with product counts, mention counts, self/competitor presence |
topProducts[] | Most mentioned products with ratings |
opportunities[] | Stores where competitors appear but brand doesn’t (priority: very-high/high) |
OAuth Scope
Requires: read:visibility
get_social_insights
Get social media and forum citations in AI responses: Reddit, YouTube, HackerNews, Stack Overflow, and more.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (default: 30) |
limit | number | No | Max communities to return (default: 10) |
Returns
| Field | Description |
|---|
summary.totalSocialCitations | Total social/forum citations |
summary.socialShareOfVoice | Social citations as % of all citations |
platformDistribution[] | Citations per platform (reddit, youtube, etc.) |
topCommunities[] | Most cited social domains with avg position |
OAuth Scope
Requires: read:sources
get_local_insights
Get local business visibility in AI responses: businesses mentioned, categories, ratings, and review counts.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (default: 30) |
limit | number | No | Max businesses to return (default: 10) |
Returns
| Field | Description |
|---|
summary | Total mentions, unique businesses, avg position, top category |
categoryDistribution[] | Mentions by business category |
topBusinesses[] | Most mentioned businesses with ratings, reviews, competitor flag |
OAuth Scope
Requires: read:visibility
get_query_fan_out
Get web search queries detected in AI responses: query variations around monitored topics with brand visibility and competitor presence per query.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (default: 30) |
limit | number | No | Max queries to return (default: 20) |
Returns
| Field | Description |
|---|
summary | Total queries, unique queries, avg brand presence % |
topQueries[] | Most frequent queries with brand presence %, competitor count, priority |
OAuth Scope
Requires: read:prompts
