Platform analytics

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.

GET /api/v1/analytics/platforms

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.
brand_id	integer	Required	The numeric ID of the brand to scope per-row metrics to. 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`.

Response

Per-AI-platform analytics row

Field	Type	Description
platform	string	The AI platform this row covers.
visibility	integer	The percentage of analyzed responses on this platform that mention the brand.
visibility_change	integer	The difference in visibility compared with the equal-length period immediately preceding the window.
share_of_voice	integer	This brand's share of the total tracked-brand mentions on this platform.
share_of_voice_change	integer	The difference in share of voice compared with the preceding period.
sentiment	integer	The average sentiment score on a 0-100 scale. `null` when the brand had no mentions on this platform.
sentiment_change	integer	The difference in sentiment compared with the preceding period. `null` when either period lacks data.
position	number	The average position of the brand within the responses on this platform 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.
used_count	integer	The number of analyzed responses on this platform inside the window.
used_count_change	integer	The difference in `used_count` compared with the preceding period.

import os import requests response = requests.get( "https://pineprompt.com/api/v1/analytics/platforms", 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/platforms', [ '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);

[ { "platform": "chatgpt", "visibility": 73, "visibility_change": 5, "share_of_voice": 28, "share_of_voice_change": -2, "sentiment": 67, "sentiment_change": 1, "position": 1.4, "position_change": -0.2, "used_count": 42, "used_count_change": 4 } ]