Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Analytics

Get Analytic

Query analytics data for a Brand Kit with flexible metrics, dimensions, and filters.

post/public_api/brand_kits/{brand_kit_id}/analytics

Path parameters

brand_kit_idinteger required

The Brand Kit ID

Request body

brand_kit_idinteger required

The Brand Kit ID to query analytics for

metricsstring[] required

Metrics to calculate. Options: mention_rate (brand mention frequency, 0-100), share_of_voice (percentage of total mentions, 0-100), citation_rate (citation frequency, 0-100), citation_share (relative citation volume, 0-100), citation_count (total citations), sentiment_score (0-100, negative to positive; null when unavailable), average_position (ranking placement), answer_count (total responses), first_mention_rate (first position frequency, 0-100)

dimensionsstring[]

Dimensions to group by (max 3).

grain'daily' | 'weekly' | 'monthly' | 'total'

Time granularity for aggregation. Default: total

start_datestring

Start date (YYYY-MM-DD). Default: 7 days ago

end_datestring

End date (YYYY-MM-DD). Defaults to yesterday. Must be before today because today's data may still be processing and is incomplete — yesterday is used to ensure robust, complete data. Leave blank unless a specific date is requested.

providersstring[]

Filter by AI providers

topicsinteger[]

Filter by topic IDs

countriesstring[]

Filter by country codes (ISO 3166-1 alpha-2)

personasinteger[]

Filter by persona IDs

themesinteger[]

Filter sentiment data by theme IDs. Only applies to sentiment_score metric.

brand_mentioned'brand' | 'category'

Filter by prompt type. Options: category (generic prompts - recommended for accurate visibility metrics), brand (prompts mentioning the brand). Defaults to category if not specified

limitinteger

Maximum rows to return (1-5000). Default: 100

offsetinteger

Number of records to skip for pagination. Default: 0. Use with limit to page through large result sets.

order_bystring

Custom sort order (e.g., "citation_count DESC")

Response

Successful response

dataobject[]

Query results with requested dimensions and metrics

errorstring

Error message if query failed

chart_image_urlstring nullable

QuickChart.io URL for visualizing the data. Useful for displaying charts or embedding in Notion/Google docs, etc. DO NOT DISPLAY THIS IMAGE DIRECTLY TO THE USER. Null when no data is available to visualize.