Skip to main content
GET
Get performance snapshot
Returns response-level metrics for the selected answer scope, plus topic, tag, competitor, and source breakdowns.
This endpoint returns aggregated metrics. See Competitor and Source for entity structures used in topCompetitors and topSources.

Metric formulas

Understanding how metrics are calculated is essential for reproducing results:
Mention Rate and Coverage have different denominators. The response exposes mentionCount, mentionTotal, and responsesTotal; it does not expose sovSelf or sovTotal.
string
required
Bearer token. Example: Bearer qw-api-xxx

Path parameters

string
required
The unique identifier of the brand

Query parameters

number
Number of days to include in the snapshot. If not specified, returns all data.
string
Start date in YYYY-MM-DD. Provide it with endDate; a lone boundary is currently ignored. Choose either period or the complete date pair.
string
End date in YYYY-MM-DD. Provide it with startDate; a lone boundary is currently ignored. Do not combine the complete date pair with period.
Use one date mode per request. Combining period with a complete custom date pair can make the applied filter diverge from the returned period metadata.
string
Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).
string
Filter by topic ID (keywordId). Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by tag ID. Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by prompt type: TOFU, MOFU, BOFU

Response

boolean
Indicates if the request was successful
object
object
object
object
array
Top competitors by mention count
array
Top sources by citation count
array
array

Synthetic request

Synthetic response

Errors

See Rate limits for retry behavior.