Monitor analytics

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

GET /api/v1/analytics/monitors

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`.
page	integer	Optional	The page number to return. Defaults to `1`.
per_page	integer	Optional	The number of items per page. Defaults to `25`, maximum `100`.
sort_by	string	Optional	The field to sort by. Defaults to `visibility`.
sort_order	string	Optional	The direction to sort by. Each endpoint has its own default.

Response

Response schema

Field	Type	Description
data	MonitorAnalytics[]
links	PaginationLinks
meta	PaginationMeta

Per-monitor analytics row

Field	Type	Description
monitor	Monitor	The monitor this row covers.
brand	Brand	The brand the metrics are scoped to.
visibility	integer	The percentage of analyzed responses on this monitor 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 monitor.
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 through this monitor.
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 monitor 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.

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

{ "data": [ { "monitor": { "id": 271, "project_id": 42, "name": "Brand visibility (US)", "models": [ "chatgpt", "perplexity", "claude" ], "country": "US", "language": "en", "is_active": true, "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }, "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" }, "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 } ], "links": { "first": "https://pineprompt.com/api/v1/monitors?page=1", "last": "https://pineprompt.com/api/v1/monitors?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://pineprompt.com/api/v1/monitors", "per_page": 25, "to": 1, "total": 1, "links": [ { "url": "https://pineprompt.com/api/v1/monitors?page=2", "label": "2", "page": 2, "active": false } ] } }