api reference

Monitors

Alert rules that check a query's result on a schedule and notify subscribed destinations.

POST/api/monitors

Create a monitor on a query.

Request

{ "query_id": 42, "name": "Signup drop", "options": { "column": "count", "op": "<", "value": 10 }, "rearm": 3600 }

Response

{
  "id": 15,
  "name": "Signup drop",
  "query": { "id": 42, "name": "Weekly signups" },
  "options": { "column": "count", "op": "<", "value": 10 },
  "state": "ok",
  "rearm": 3600,
  "user": { "id": 12, "name": "Jane Doe", "email": "[email protected]" },
  "escalation_step": 0,
  "escalation": [],
  "caller": { "can_edit": true }
}

POST/api/monitors/{id}/run

Manually check the monitor now, through the runs pipeline. Returns 201 if a new run started, 200 if one was already in flight.

Response

{ "id": 7781, "status": "started", "triggered_by": "user", "condition_met": null, "notified": [] }

POST/api/monitors/{id}/snooze

Suppress notifications for a number of minutes without disabling the monitor.

Request

{ "minutes": 60 }

GET/api/monitors/{id}/deliveries

Delivery history for this monitor, newest first, capped at 50 rows.

Response

[
  { "id": 900, "created_at": "2026-07-17T12:00:00Z", "destination_id": 4, "subscription_id": 3, "state": "sent", "status": "success", "error": null, "attempt_number": 1 }
]