Skip to main content
GET
/
monitors
List Monitors
curl --request GET \
  --url https://api.exa.ai/monitors \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "object": "search_monitor",
      "name": "<string>",
      "status": "active",
      "search": {
        "query": "<string>",
        "numResults": 50,
        "contents": {
          "text": true,
          "highlights": true,
          "summary": true,
          "extras": {
            "links": 500,
            "imageLinks": 500,
            "richImageLinks": 500,
            "richLinks": 500,
            "codeBlocks": 500
          },
          "context": true,
          "livecrawl": "never",
          "livecrawlTimeout": 45000,
          "maxAgeHours": 123,
          "filterEmptyResults": true,
          "subpages": 50,
          "subpageTarget": "<string>"
        }
      },
      "trigger": {
        "type": "interval",
        "period": "6h"
      },
      "outputSchema": {
        "type": "text",
        "description": "<string>",
        "properties": {},
        "required": [
          "<string>"
        ],
        "additionalProperties": false
      },
      "metadata": {
        "slack_channel_id": "C123ABC",
        "slack_thread_id": "1745444400.123456",
        "user_id": "U123ABC"
      },
      "webhook": {
        "url": "<string>",
        "events": [
          "monitor.created"
        ]
      },
      "nextRunAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://exa.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
status
enum<string>

Filter monitors by status

Available options:
active,
paused,
disabled
​
cursor
string

Pagination cursor from a previous response

​
limit
integer
default:50

Number of results per page

Required range: 1 <= x <= 100
​
name
string

Filter monitors by name (case-insensitive substring match)

Maximum string length: 250
​
metadata
object

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

Response

A paginated list of monitors

​
data
object[]
required

The list of monitors

​
hasMore
boolean
required

Whether there are more results

​
nextCursor
string | null

Cursor for the next page