Skip to main content
GET
/
v0
/
monitors
cURL
curl --request GET \
  --url https://api.exa.ai/websets/v0/monitors \
  --header 'x-api-key: <api-key>'
# pip install exa-py
from exa_py import Exa

exa = Exa("YOUR_EXA_API_KEY")

monitors = exa.websets.monitors.list(webset_id="webset_id")

print(f"Found {len(monitors.data)} monitors")
for monitor in monitors.data:
print(f"- {monitor.id}: {monitor.status}")
// npm install exa-js
import Exa from "exa-js";
const exa = new Exa("YOUR_EXA_API_KEY");

const monitors = await exa.websets.monitors.list({
webset_id: "webset_id",
});

console.log(`Found ${monitors.data.length} monitors`);
monitors.data.forEach((monitor) => {
console.log(`- ${monitor.id}: ${monitor.status}`);
});
{
  "data": [
    {
      "id": "<string>",
      "object": "monitor",
      "websetId": "<string>",
      "cadence": {
        "cron": "<string>",
        "timezone": "Etc/UTC"
      },
      "behavior": {
        "type": "search",
        "config": {
          "count": 123,
          "query": "<string>",
          "criteria": [
            {
              "description": "<string>"
            }
          ],
          "entity": {
            "type": "company"
          },
          "behavior": "append"
        }
      },
      "lastRun": {
        "id": "<string>",
        "object": "monitor_run",
        "monitorId": "<string>",
        "completedAt": "2023-11-07T05:31:56Z",
        "failedAt": "2023-11-07T05:31:56Z",
        "failedReason": "<string>",
        "canceledAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "nextRunAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

x-api-key
string
header
required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Query Parameters

cursor
string

The cursor to paginate through the results

Minimum string length: 1
limit
integer
default:25

The number of results to return

Required range: 1 <= x <= 200
websetId
string

The id of the Webset to list monitors for

Response

200 - application/json

List of monitors

data
object[]
required

The list of monitors

hasMore
boolean
required

Whether there are more results to paginate through

nextCursor
string | null
required

The cursor to paginate through the next set of results