List Monitors

cURL

curl --request GET \
  --url https://api.exa.ai/websets/v0/monitors \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "monitor",
      "status": "enabled",
      "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",
        "status": "created",
        "monitorId": "<string>",
        "type": "search",
        "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>"
}

GET

monitors

cURL

curl --request GET \
  --url https://api.exa.ai/websets/v0/monitors \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "monitor",
      "status": "enabled",
      "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",
        "status": "created",
        "monitorId": "<string>",
        "type": "search",
        "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

Your Exa API key

Query Parameters

cursor

string

The cursor to paginate through the results

Minimum string length: 1

limit

number

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

Show child attributes

data.id

string

required

The unique identifier for the Monitor

data.object

enum<string>

required

The type of object

Available options:

monitor

data.status

enum<string>

required

The status of the Monitor

Available options:

enabled,

disabled

data.websetId

string

required

The id of the Webset the Monitor belongs to

data.cadence

object

required

How often the monitor will run

Show child attributes

data.cadence.cron

string

required

Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day.

data.cadence.timezone

string

default:Etc/UTC

IANA timezone (e.g., "America/New_York")

data.behavior

object

required

Behavior to perform when monitor runs

Show child attributes

data.behavior.type

string

default:search

required

Allowed value: "search"

data.behavior.config

object

required

Specify the search parameters for the Monitor.

By default, the search parameters (query, entity and criteria) from the last search are used when no parameters are provided.

Show child attributes

data.behavior.config.count

number

required

The maximum number of results to find

data.behavior.config.query

string

The query to search for. By default, the query from the last search is used.

Required string length: 2 - 10000

data.behavior.config.criteria

object[]

The criteria to search for. By default, the criteria from the last search is used.

Maximum array length: 5

Show child attributes

data.behavior.config.criteria.description

string

required

Required string length: 2 - 1000

data.behavior.config.entity

Company · object

The entity to search for. By default, the entity from the last search/import is used.

Company
Person
Article
Research Paper
Custom

Show child attributes

data.behavior.config.entity.type

string

default:company

required

Allowed value: "company"

data.behavior.config.behavior

enum<string>

default:append

The behaviour of the Search when it is added to a Webset.

Available options:

override,

append

data.lastRun

MonitorRun · object

required

The last run of the monitor

Show child attributes

data.lastRun.id

string

required

The unique identifier for the Monitor Run

data.lastRun.object

enum<string>

required

The type of object

Available options:

monitor_run

data.lastRun.status

enum<string>

required

The status of the Monitor Run

Available options:

created,

running,

completed,

canceled,

failed

data.lastRun.monitorId

string

required

The monitor that the run is associated with

data.lastRun.type

enum<string>

required

The type of the Monitor Run

Available options:

search,

refresh

data.lastRun.completedAt

string<date-time> | null

required

When the run completed

data.lastRun.failedAt

string<date-time> | null

required

When the run failed

data.lastRun.failedReason

string | null

required

The reason the run failed

data.lastRun.canceledAt

string<date-time> | null

required

When the run was canceled

data.lastRun.createdAt

string<date-time>

required

When the run was created

data.lastRun.updatedAt

string<date-time>

required

When the run was last updated

data.nextRunAt

string<date-time> | null

required

Date and time when the next run will occur in

data.metadata

object

required

Set of key-value pairs you want to associate with this object.

Show child attributes

data.metadata.{key}

string

Maximum string length: 1000

data.createdAt

string<date-time>

required

When the monitor was created

data.updatedAt

string<date-time>

required

When the monitor was last updated

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

Delete Monitor List Monitor Runs

⌘I

Getting Started

Dashboard

API

List Monitors

Authorizations

Query Parameters

Response