Get a monitor

Returns a single monitor. The monitor must belong to the active project.

GET /api/v1/monitors/{monitor}

Path parameters

Name	Type	Required	Description
monitor	integer	Required	The numeric ID of the monitor.

Query parameters

Name	Type	Required	Description
include	string	Optional	A comma-separated list of related resources to include in the response. Allowed values: `project`, `project.organization`.

Response

The monitor object

Field	Type	Description
id	integer	The unique ID of the monitor.
project_id	integer	The ID of the project this monitor runs under.
name	string	The display name of the monitor.
models	string[]	The AI engines the monitor runs against.
country	string	The ISO 3166-1 alpha-2 country code.
language	string	The language the monitor runs in.
is_active	boolean	Whether the monitor will run on its next daily run.
created_at	datetime	When the monitor was created.
updated_at	datetime	When the monitor was last updated.

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

{ "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" }