Analytics
Share-of-voice time-series
Returns each tracked brand's mentions as a share of the mentions of the brands in the filter scope, per bucket. Without a brand_id or segments parameter, the scope is every tracked brand in the project. You may pass segments to read each share within the selected segments, since the segment scopes both the series and the denominator, or brand_id to scope the ratio to a single brand, which reads 100 in any bucket where the brand has mentions and 0 where it has none. The top_n cap only limits how many series are returned and never affects the denominator.
/api/v1/analytics/share-of-voice-time-series
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 |
| interval | string | Required | The bucketing granularity for time-series endpoints. Accepted values: |
| brand_id | integer | Optional | You may set this parameter to scope a time-series chart to a single brand, which produces a single-brand line. The brand must belong to the active project. A single-brand share-of-voice series is measured against the brand's own mentions, so it reads |
| 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 |
| top_n | integer | Optional | The maximum number of series to return from a time-series endpoint. Series are ranked by total mentions or citations in the window. Defaults to 20, with a maximum of 50. |
Response
Share-of-voice time-series
| Field | Type | Description |
|---|---|---|
| interval | string | The bucket granularity used to compute the series. |
| series | BrandShareOfVoiceSeries[] | One entry per brand in scope, each carrying a dense list of buckets. |
Per-brand share-of-voice series
| Field | Type | Description |
|---|---|---|
| brand | Brand | The brand this series covers. |
| data | TimeSeriesPoint[] | The bucketed data points for this brand. Each value is the brand's mentions expressed as a percentage of the mentions of the brands in the filter scope in the bucket. |
Time-series data point
| Field | Type | Description |
|---|---|---|
| timestamp | datetime | The ISO 8601 UTC start of the bucket. |
| value | integer | The metric value for this bucket. The series that carries the point describes what the value measures. |