Sign in

v5

latestSwagger 2.0Proprietary2026-08-0473264.9 KB
Metrics

Aggregated metrics summary

Same as /metrics/timeseries with an extra summary + position_distribution block. Citations and citation rate include visible citations and background source references; background references use position 0 and are excluded from avg_position and position distributions. total is a SUM for count metrics and an AVERAGE across periods for rate/percentage metrics (never summed); each summary row carries an aggregation field (sum or average).

get/metrics/summary

Query parameters

project_idinteger required

Project ID

metricsstring

Comma-separated list of metrics: mentions, citations, responses, mention_rate, visibility, weighted_visibility, ai_visibility_score, citation_rate, avg_position, avg_mention_position, net_sentiment, sentiment__. Citations and citation_rate include visible citations and background source references; avg_position uses visible citations only.

granularity'day' | 'week' | 'month'
rangeinteger

Number of days to look back

fromstring date-time
tostring date-time
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.

Response

Summary metrics