v1

latestOpenAPI 3.1.02026-08-0458114534.0 KB

Monitors

List Monitors

Lists all monitors for the authenticated team. Supports filtering by status and cursor-based pagination.

get/monitors

Query parameters

status'active' | 'paused' | 'disabled'

Filter monitors by status

cursorstring

Pagination cursor from a previous response

limitinteger

Number of results per page

namestring

Filter monitors by name (case-insensitive substring match)

metadataobject

Filter monitors by metadata key-value pairs (exact match, AND semantics). Use bracket notation: metadata[key]=value.

Response

A paginated list of monitors

hasMoreboolean required

Whether there are more results

nextCursorstring nullable

Cursor for the next page

Example response

{
  "data": [
    {
      "search": {
        "query": "Latest developments in LLM capabilities",
        "numResults": 10,
        "contents": {
          "text": {
            "maxCharacters": 1000,
            "verbosity": "standard",
            "includeSections": [
              "body",
              "header"
            ],
            "excludeSections": [
              "navigation",
              "footer",
              "sidebar"
            ]
          },
          "highlights": {
            "query": "Key advancements",
            "maxCharacters": 2000,
            "numSentences": 1,
            "highlightsPerUrl": 1
          },
          "summary": {
            "query": "Main developments"
          },
          "extras": {
            "links": 1,
            "imageLinks": 1
          },
          "context": true,
          "livecrawlTimeout": 1000,
          "maxAgeHours": 24,
          "subpages": 1
        }
      },
      "trigger": {
        "period": "6h"
      },
      "metadata": {
        "slack_channel_id": "C123ABC",
        "slack_thread_id": "1745444400.123456",
        "user_id": "U123ABC"
      }
    }
  ]
}