Skip to main content
GET
Get Performance Snapshot
Get a comprehensive overview of your brand’s visibility in AI-generated responses. Includes mention rates, source citations, sentiment scores, share of voice, and breakdowns by topic and competitor.
This endpoint returns aggregated metrics. See Competitor and Source for entity structures used in topCompetitors and topSources.

Key Formulas

Understanding how metrics are calculated is essential for reproducing results:
Common mistake: Using total responses as the denominator for Mention Rate, or including INDIRECT competitor mentions in the Share of Voice denominator. The API returns sovSelf and sovTotal so you can verify the calculation.

Get Performance Snapshot

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 (ISO 8601 format). Overrides period if provided with endDate
string
End date (ISO 8601 format). Overrides period if provided with startDate
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

Example Request

Example Response

Error Responses