Get Citations
get_citationsGet citation data showing which URLs AI models cite for your brand.
Citations are the source URLs that AI search engines reference in their answers. This tool shows which pages get cited, how often, and trends.
Views:
'list' (default): All citation URLs with metadata.
'history': Citation count trends over time.
'queries': Which search queries generate citations, clustered by topic.
'sources': Deep dive on a specific domain (requires 'domain' param).
'feed': Recent citation events (new, lost, changed).
'recent': Compatibility alias for 'feed'.
'heatmap': Citation coverage matrix across domains and brands.
'analytics': Aggregate citation analytics and metrics.
'detail': Detail for a specific URL (pass the URL via the 'domain' param).
'by_model': Citation breakdown per AI model.
'top_pages': Top cited pages ranked by lifetime citation count. Each page also carries appearance_count_30d for the same 30-day window the rest of the citation views use.
daysdoes not move this view; use view='history' for a trend over a window.
Args:
brand_id: The brand to check (required).
view: Data view. Default 'list'.
days: Lookback window, 7-365. Default 30.
period: A frozen calendar period (YYYY-MM or YYYY-Qn). When given,
days is ignored and the response carries a period block. Only
view='top_pages' (citations inside the period, with
appearance_count_period and models) and view='analytics'
(activity inside the period; top_domains are the domains cited
most with no page naming the brand, and period_figures carries
the period totals) support it.
limit: Results per page, 1-500. Default 100.
offset: Pagination offset.
domain: Required when view='sources' or view='detail'. The domain or URL to analyze.
days_back: view='feed' only, and rarely needed. Omit it and the feed
uses days, capped at 30. Set it only to compare over a different
window than the rest of the call.
tag_ids: Comma-separated tag IDs to filter prompts.
prompt_text: Filter to prompts containing this text.
response_format: 'concise' (default) caps long citation lists to a
readable head to protect the model's context; 'detailed' returns
every row (still held under the response ceiling).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| view | No | list | |
| limit | No | ||
| domain | No | Required when view='sources' or view='detail', ignored otherwise. A domain for view='sources' (example.com), a full URL for view='detail'. | |
| offset | No | ||
| period | No | ||
| tag_ids | No | ||
| brand_id | Yes | ||
| days_back | No | view='feed' only, and rarely needed: the feed's comparison window in days. Omit it and `days` is used (capped at 30). Every other view ignores this. | |
| prompt_text | No | ||
| user_intent | No | Analytics hint: the user's latest request in one short sentence. Omit secrets and prior chat. | |
| response_format | No | concise |