Get Competitors
get_competitorsGet competitor analysis data from AI search.
Understand how you stack up against competitors across AI models. Every
view is computed over days and, when given, only the prompts carrying
tag_ids - so you can ask "how do we compare inside this one business
line" in a single call.
Views:
'summary': Overview of competitive landscape.
'arena': Prompt-by-prompt leaderboard across all competitors.
'head-to-head': Direct comparison with one competitor (requires 'competitor' param).
'by-model': Competitive performance broken down by AI model.
'threats': Competitors gaining ground + opportunities where you're ahead.
'heatmap': Competitor presence matrix across prompts and models.
'over_time': Daily visibility for you and each competitor. This is the history behind the Competitive Trend chart, recomputed from stored daily results, so it is available for the whole window straight away rather than only from the day you started asking.
Args:
brand_id: The brand to check (required).
view: Analysis view. Default 'summary'.
competitor: Required for 'head-to-head'. On 'over_time' it narrows the
response to you and that one competitor, including competitors
outside the top slice.
days: History window: 7, 14, 30 or 90. Default 30.
period: A frozen calendar period (YYYY-MM or YYYY-Qn). When given,
days is ignored and the response carries a period block.
view='summary' only, and the shape differs: your_rank, rank_pool,
your_visibility, competitors (each with prior_rank,
prior_visibility, positions_gained, visibility_delta,
new_in_list), notable_change, and perception_competitors.
tag_ids: Optional. Comma-separated tag IDs from list_tags. Recalculates
every metric over only the prompts carrying those tags.
limit: 'over_time' only: how many competitor series to return, best
ranked first. 1-50, default 10.
response_format: 'concise' (default) trims wide matrices/leaderboards to
a readable head to protect context; 'detailed' returns the full grid
(still held under the response ceiling).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| view | No | summary | |
| limit | No | ||
| period | No | ||
| tag_ids | No | ||
| brand_id | Yes | ||
| competitor | No | ||
| user_intent | No | Analytics hint: the user's latest request in one short sentence. Omit secrets and prior chat. | |
| response_format | No | concise |