Analytics
Brand analytics
Returns per-brand aggregates across the window: visibility, share of voice, average sentiment (0-100), and average position. Sentiment and position are null when the brand has no mentions in the window. Every tracked brand in scope is returned, including those with no mentions. The response is paginated.
/api/v1/analytics/brands
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| start_date | string | Required | The inclusive UTC start of the analytics window, given as an ISO 8601 date ( |
| end_date | string | Required | The inclusive UTC end of the analytics window. The value must be on or after |
| platforms | string[] | Optional | You may use this parameter to limit responses to one or more AI platforms. Repeat the parameter for each value, for example |
| countries | string[] | Optional | You may use this parameter to limit responses to monitors run in the given ISO-3166-1 alpha-2 country codes. |
| monitors | integer[] | Optional | You may use this parameter to limit responses to specific monitors inside the active project. |
| segments | integer[] | Optional | You may use this parameter to limit responses and brand-scoped metrics to brands attached to any of the given segments. Segments are named groupings of brands, such as |
| tags | integer[] | Optional | You may use this parameter to limit responses to those whose prompt carries any of the given tag IDs, such as |
| page | integer | Optional | The page number to return. Defaults to |
| per_page | integer | Optional | The number of items per page. Defaults to |
| sort_by | string | Optional | The field to sort by. Defaults to |
| sort_order | string | Optional | The direction to sort by. Each endpoint has its own default. |
Response
Response schema
| Field | Type | Description |
|---|---|---|
| data | BrandAnalytics[] | |
| links | PaginationLinks | |
| meta | PaginationMeta |
Per-brand analytics row
| Field | Type | Description |
|---|---|---|
| brand | Brand | The brand this row covers. |
| visibility | integer | The percentage of analyzed responses in the window that mention this brand. |
| visibility_change | integer | The difference in visibility compared with the equal-length period immediately preceding the window. A positive value indicates an improvement. |
| share_of_voice | integer | This brand's share of the mentions of the brands in the filter scope across the window. A segment filter narrows the scope to the segment's brands. |
| share_of_voice_change | integer | The difference in share of voice compared with the preceding period. |
| sentiment | integer | The average sentiment score of this brand's mentions, on a 0-100 scale. |
| sentiment_change | integer | The difference in sentiment compared with the preceding period. |
| position | number | The average position of this brand within the responses that mention it. A lower value is better. |
| position_change | number | The difference in position compared with the preceding period. A negative value indicates an improvement, since the average position has moved closer to the top of the answer. |