Skip to main content
GET
/
v1alpha
/
monitors
List Monitors
import requests

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

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

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

print(response.text)
[
  {
    "monitor_id": "<string>",
    "query": "<string>",
    "status": "active",
    "cadence": "daily",
    "created_at": "2023-11-07T05:31:56Z",
    "metadata": {
      "key": "value"
    },
    "webhook": {
      "url": "<string>",
      "event_types": [
        "monitor.event.detected"
      ]
    },
    "last_run_at": "2025-01-15T10:30:00Z"
  }
]

Authorizations

​
x-api-key
string
header
required

Response

Successful Response

​
monitor_id
string
required

ID of the monitor.

​
query
string
required

The query being monitored.

​
status
enum<string>
required

Status of the monitor.

Available options:
active,
canceled
​
cadence
enum<string>
required

Cadence of the monitor.

Available options:
daily,
weekly,
hourly
​
created_at
string<date-time>
required

Timestamp of the creation of the monitor.

​
metadata
Metadata · object

User-provided metadata stored with the monitor.

Example:
{ "key": "value" }
​
webhook
MonitorWebhook · object

Webhook configuration for the monitor.

​
last_run_at
string | null

Timestamp of the last run for the monitor.

Example:

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