Analytics

Returns the share of analyzed responses that mention each tracked brand, bucketed by interval. You may scope the chart to a single brand by passing brand_id, or to every brand in a segment by passing segments. Otherwise, the result is capped to the top top_n brands by mention count, which defaults to 20 and may not exceed 50.

Returns the average sentiment score, on a 0-100 scale, of each tracked brand's mentions, bucketed by interval. You may scope the chart to a single brand by passing brand_id, or to every brand in a segment by passing segments. Otherwise, the result is capped to the top top_n brands by mention count. A per-bucket value is null when the brand had no mentions in that bucket.

Returns the average position of each tracked brand within the answers that mention it, bucketed by interval. Position counts the brands in the order they appear in an answer, so a lower number is a more prominent placement and 1 is the first brand named. You may scope the chart to a single brand by passing brand_id, or to every brand in a segment by passing segments. Otherwise, the result is capped to the top top_n brands by mention count. A per-bucket value is null when the brand had no mentions in that bucket.

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.

For each top source, returns the percentage of analyzed responses in each bucket that cited that source. The result is capped to the top top_n sources by citation count. Source-keyed analytics cannot be scoped by segment.

For each top URL, returns the percentage of analyzed responses in each bucket that cited that exact URL. The result is capped to the top top_n URLs. Source-keyed analytics cannot be scoped by segment.

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.

Returns per-monitor aggregates across the filter window, scoped to a single brand. The response is paginated.

Returns per-prompt aggregates across the filter window, scoped to a single brand. Each row also lists the distinct tracked brands that were mentioned in the prompt's responses during the window. The response is paginated.

Returns per-platform aggregates across the filter window, scoped to a single brand. Every platform present in the filtered response set is returned; the result is not paginated.

Returns per-source aggregates: the percentage of analyzed responses in the window that cited each domain, together with the average number of citations from that domain per analyzed response. The response is paginated. This endpoint may not be scoped by segment.

Returns per-URL aggregates: the percentage of analyzed responses in the window that cited each URL, together with the average number of citations to it per analyzed response. The response is paginated. This endpoint may not be scoped by segment.

Returns per-prompt aggregates scoped to a single source URL: how many distinct analyzed responses on each prompt cited the URL during the window, and when the URL was most recently cited. The response is paginated. This endpoint may not be scoped by segment.

Returns a citation breakdown across the source-type classifications, such as blog, news, or forum. The result is unpaginated and contains one row per enum value. This endpoint may not be scoped by segment.

Returns a citation breakdown across the URL-type classifications, such as article, documentation, or product_page. The result is unpaginated and contains one row per enum value. This endpoint may not be scoped by segment.