Sign in

v4

Swagger 2.0Proprietary2026-08-0173264.4 KB
Metrics

Share of Voice

get/metrics/sov

Query parameters

project_idinteger required

Project ID

rangeinteger

Number of days to look back

fromstring date-time
tostring date-time
granularity'day' | 'week' | 'month'
competitorsstring

Comma-separated competitor IDs

model'chatgpt' | 'perplexity' | 'gemini' | 'ai_overview' | 'ai_mode' | 'copilot' | 'claude' | 'grok' | 'deepseek' | 'meta_ai' | 'amazon_rufus'

Filter by AI model. Models the API key's user has not enabled are silently dropped.

collection_idinteger
promptinteger
prompt_type'informational' | 'navigational' | 'commercial' | 'transactional'

Filter by prompt type (search intent).

brand_kind'brand' | 'brand_other' | 'non_brand'

Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.

output'flat' | 'csv'

Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. 'flat' returns the same metadata plus 'columns' and 'rows'; 'csv' returns those rows as text/csv. Errors are always returned as JSON.

view'over_time' | 'current' | 'breakdown'

Which Share of Voice projection to flatten. Only valid together with 'output'. 'over_time' (default) is one row per date and actor, 'current' the ranked snapshot, 'breakdown' the Top 4 plus Others.

Response

Share of voice data