Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
Monitors

List monitors

Lists monitors for the authenticated organization. Supports free-text search (q over search_by fields, prefix or exact via search_type) plus status/type/tag filters. Results are paginated via the opaque cursor.

get/monitors

Query parameters

qstring

Free-text search term, matched against the fields named in search_by.

Example:pricing

Free-text search term, matched against the fields named in search_by.

search_bystring[] nullable

Comma-separated fields to search with q. Defaults to all of them. Note instructions only exists on extract monitors.

Comma-separated fields to search with q. Defaults to all of them. Note instructions only exists on extract monitors.

search_type'exact' | 'prefix'

prefix for as-you-type prefix matching (default), exact for full-token matching.

prefix for as-you-type prefix matching (default), exact for full-token matching.

status'active' | 'paused' | 'failed'

Filter monitors by lifecycle status.

Filter monitors by lifecycle status.

target_type'page' | 'sitemap' | 'extract'

Filter by target type.

Filter by target type.

change_detection_type'exact' | 'semantic'

Filter by change detection type.

Filter by change detection type.

tagsstring[] nullable

Comma-separated list of tags to filter by (matches monitors having any of them).

Comma-separated list of tags to filter by (matches monitors having any of them).

tagstring

Filter to items that have this tag.

Example:pricing

Filter to items that have this tag.

limitinteger

Maximum number of items to return per page (1-100). Defaults to 25.

Maximum number of items to return per page (1-100). Defaults to 25.

cursorstring

Opaque pagination cursor from a previous response.

Opaque pagination cursor from a previous response.

Response

A paginated list of monitors

has_moreboolean required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "mon_123",
      "name": "Acme pricing monitor",
      "target": {
        "url": "https://acme.com/pricing",
        "instructions": "Report pricing or plan availability changes. Ignore counters, timestamps, testimonials, and navigation."
      },
      "schedule": {
        "frequency": 6,
        "unit": "hours"
      },
      "webhook": {
        "url": "https://example.com/webhook",
        "events": [
          "change.detected",
          "run.completed"
        ],
        "secret": "whsec_8f3a…"
      },
      "last_error": {
        "code": "fetch_failed",
        "message": "The target URL could not be fetched."
      },
      "webhook_failure": {
        "consecutive_failures": 3,
        "last_message": "Webhook endpoint returned HTTP 429."
      },
      "tags": [
        "pricing",
        "competitor"
      ],
      "baseline": {
        "text": "Acme Pricing\nStarter $9/mo…"
      }
    }
  ]
}