Get AI Rankings
get_rankingsGet competitive ranking data in AI search results.
Shows where the brand ranks relative to competitors across all tracked prompts and AI models. Useful for understanding competitive positioning.
Views:
'overall': Aggregate rankings across all prompts.
'by-prompt': Rankings broken down per prompt.
'prompt-trends': Daily average position per prompt, for the brand and the competitors it meets on that prompt. This is the view that answers which specific prompts are being lost and since when. Position is average rank in the answer, so LOWER is better and a positive
position_changemeans the brand slipped down.
Args:
brand_id: The brand to check (required).
view: 'overall', 'by-prompt' or 'prompt-trends'. Default 'overall'.
days: Lookback window, 1-365. Default 30. view='overall' reads at most
90 days and reports what it used in days_effective;
view='prompt-trends' uses at least 7 and at most 90.
period: A frozen calendar period (YYYY-MM or YYYY-Qn). When given,
days is ignored and the response carries a period block.
view='overall' only; not found if no rank was archived for that
period; win_rate and threat_count come back null.
include_volume: Include search volume estimates.
tag_ids: Optional. Comma-separated tag IDs from list_tags. Applies to
view='overall' and view='prompt-trends'.
limit: 'prompt-trends' only: how many prompts to return, most-measured
first. 1-100, default 25.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| view | No | overall | |
| limit | No | ||
| period | No | ||
| tag_ids | No | ||
| brand_id | Yes | ||
| user_intent | No | Analytics hint: the user's latest request in one short sentence. Omit secrets and prior chat. | |
| include_volume | No |