monitors

Get a monitor

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

get/api/v1/monitors/{monitor}

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/monitors/{monitor}
  • Auth: HTTP bearer

Path parameters

monitorinteger required
Example:271

The numeric ID of the monitor.

Query parameters

includestring
Example:project

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

idinteger

The unique ID of the monitor.

project_idinteger

The ID of the project this monitor runs under.

namestring

The display name of the monitor.

platformsstring[]

The AI platforms the monitor runs against.

countrystring

The ISO 3166-1 alpha-2 country code.

languagestring

The language the monitor runs in.

is_activeboolean

Whether the monitor will run on its next daily run.

created_atstring date-time

When the monitor was created.

updated_atstring date-time

When the monitor was last updated.

Example response

{
  "id": 271,
  "project_id": 42,
  "name": "Brand visibility (US)",
  "platforms": [
    "chatgpt",
    "perplexity",
    "claude"
  ],
  "country": "US",
  "language": "en",
  "is_active": true,
  "project": {
    "id": 42,
    "organization_id": 7,
    "name": "Acme Marketing",
    "brand_id": 555,
    "organization": {
      "id": 7,
      "name": "Acme Inc.",
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "created_at": "2026-05-15T09:11:42+00:00",
    "updated_at": "2026-05-15T09:11:42+00:00"
  },
  "created_at": "2026-05-15T09:11:42+00:00",
  "updated_at": "2026-05-15T09:11:42+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.