Sentiment time-series

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.

GET /api/v1/analytics/sentiment-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 (`YYYY-MM-DD`).
end_date	string	Required	The inclusive UTC end of the analytics window. The value must be on or after `start_date`, and on or before today.
interval	string	Required	The bucketing granularity for time-series endpoints. Week buckets begin on Monday.
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.
models	string[]	Optional	You may use this parameter to limit responses to one or more AI engines. Repeat the parameter for each value, for example `?models[]=chatgpt&models[]=claude`.
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 `Direct Competitors`. When this parameter is set, time-series charts show every brand in the selected segments instead of capping the series at `top_n`. Source-keyed endpoints do not honor this parameter.
tags	integer[]	Optional	You may use this parameter to limit responses to those whose prompt carries any of the given tag IDs, such as `branded` or `non-branded`.
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

Sentiment time-series

Field	Type	Description
interval	string
series	BrandSentimentSeries[]	One entry per brand in scope, each carrying a dense list of buckets.

Per-brand sentiment series

Field	Type	Description
brand	Brand	The brand this series covers.
data	SentimentTimeSeriesPoint[]	The bucketed data points for this brand.

Sentiment time-series data point

Field	Type	Description
timestamp	datetime	The ISO 8601 UTC start of the bucket.
value	integer	The average sentiment score for the bucket, on a 0-100 scale. `null` when the brand was not mentioned in this bucket.

import os import requests response = requests.get( "https://pineprompt.com/api/v1/analytics/sentiment-time-series", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->get('https://pineprompt.com/api/v1/analytics/sentiment-time-series', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);

{ "interval": "day", "series": [ { "brand": { "id": 555, "project_id": 42, "display_name": "Acme Inc.", "aliases": [ "Acme", "Acme Co" ], "domains": [ "acme.com", "acme.co" ], "kind": "competitor", "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }, "data": [ { "timestamp": "2026-04-01T00:00:00+00:00", "value": 67 } ] } ] }