Run a dimensional analytics query for a product
Query one analytics metric (sov, citations, traffic, sentiment) grouped by at most one dimension, scoped by filters and a date window. Returns flat rows plus column metadata for generic rendering.
Authorizations
Organization-scoped API key. Available scopes:
- content:read: Read site pages, markdown content, and llms.txt files
- content:write: Create, update, and delete site pages and content
- prompts:read: Read prompts, topics, and prompt analysis results
- prompts:write: Create, update, archive prompts
- simulations:read: Read agent-simulation tasks, runs, environments, and analytics
- simulations:write: Create and trigger simulation runs
- logs:read: Read AI-traffic logs and request-level audit events
- analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
- analytics:write: Write events to analytics
- products:read: Read product metadata and competitor data
- products:write: Update product settings and competitor lists
Body
Product ID to scope the query to.
1Metric to query. Ungrouped and date-dimension SoV use trailing-30-day snapshots rather than additive period totals.
sov, citations, traffic, sentiment At most one dimension to group by. Omit or pass [] for a summary. For metric=sov when dimensions are omitted or dimensions=[date], sov, mentions, and runs are trailing-30-day snapshot values. Omit dimensions to return only the latest available snapshot in the requested window, or use dimensions=[date] to return one snapshot per date. The window selects eligible snapshot dates; it is not a period aggregation. Do not sum mentions or runs across dated rows because their rolling windows overlap. Capabilities — sov: dimensions [date, prompt, topic, engine, competitor], filters [viewId, promptId, topicId, engine, regionId], sortBy [sov, mentions, runs, label]; citations: dimensions [source, category, type, author, model, date], filters [viewId, topicId, regionId, category, contentType, model, author, searchTerm, productMentioned], sortBy [citations, mentions]; traffic: dimensions [date, page, model, category], filters [trafficType, provider, category]; sentiment: dimensions [prompt], filters [viewId, promptId, topicId].
11Date window; both start and end or neither. Defaults to the last 30 days. For metric=sov when dimensions are omitted or dimensions=[date], sov, mentions, and runs are trailing-30-day snapshot values. Omit dimensions to return only the latest available snapshot in the requested window, or use dimensions=[date] to return one snapshot per date. The window selects eligible snapshot dates; it is not a period aggregation. Do not sum mentions or runs across dated rows because their rolling windows overlap.
Time bucket for metric=traffic with the date dimension. Defaults to day.
day, week, month Week-over-week comparison, metric=sentiment only.
wow x >= 11 <= x <= 1001asc, desc