List Monitors

List active monitors.

Returns all monitors for the user, regardless of status. Each list item contains the monitor configuration and current status.

Supports pagination using monitor_id as a cursor and limit to control the number of results returned.

GET /v1alpha/monitors

List Monitors

Python

import requests

url = "https://api.parallel.ai/v1alpha/monitors"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

[
  {
    "monitor_id": "monitor_b0079f70195e4258a3b982c1b6d8bd3a",
    "query": "Extract recent news about AI",
    "status": "active",
    "cadence": "daily",
    "metadata": {
      "key": "value"
    },
    "webhook": {
      "url": "https://example.com/webhook",
      "event_types": [
        "monitor.event.detected"
      ]
    },
    "created_at": "2025-04-23T20:21:48.037943Z"
  },
  {
    "monitor_id": "monitor_b0179f70195e4258a3b982c1b6d8bd3a",
    "query": "Extract recent news about AI",
    "status": "canceled",
    "cadence": "daily",
    "metadata": {
      "key": "value"
    },
    "webhook": {
      "url": "https://example.com/webhook",
      "event_types": [
        "monitor.event.detected"
      ]
    },
    "created_at": "2025-04-23T20:21:48.037943Z"
  }
]

Authorizations

x-api-key · string · header · required

Query Parameters

monitor_id · string | null

Monitor ID to start listing after (for pagination). Returns monitors starting with this ID in lexicographic order.

limit · integer | null

Maximum number of monitors to return. Defaults to returning all monitors.

Required range: 1 <= x <= 10000

Response

200

application/json

Successful Response

monitor_id · string · required

ID of the monitor.

query · string · required

The query being monitored.

Example:

"Recent news about LLM models."

status · enum<string> · required

Status of the monitor.

Available options: active, canceled

Examples:

"active"

"canceled"

cadence · enum<string> · required

Cadence of the monitor.

Available options: daily, weekly, hourly, every_two_weeks

Examples:

"daily"

"weekly"

"hourly"

"every_two_weeks"

created_at · string<date-time> · required

Timestamp of the creation of the monitor.

Example:

"2025-01-15T10:30:00Z"

metadata · Metadata · object

User-provided metadata stored with the monitor.

Show child attributes

Example:

{ "key": "value" }

webhook · MonitorWebhook · object

Webhook configuration for the monitor.

Show child attributes

last_run_at · string | null

Timestamp of the last run for the monitor.

Example:

"2025-01-15T10:30:00Z"