Skip to main content
GET
/
v0
/
events
cURL
curl --request GET \
  --url https://api.exa.ai/websets/v0/events \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "object": "event",
      "type": "webset.created",
      "data": {
        "id": "<string>",
        "object": "webset",
        "status": "idle",
        "externalId": "<string>",
        "title": "<string>",
        "searches": [
          {
            "id": "<string>",
            "object": "webset_search",
            "status": "created",
            "websetId": "<string>",
            "query": "<string>",
            "entity": {
              "type": "company"
            },
            "criteria": [
              {
                "description": "<string>",
                "successRate": 50
              }
            ],
            "count": 2,
            "exclude": [
              {
                "source": "import",
                "id": "<string>"
              }
            ],
            "scope": [
              {
                "source": "import",
                "id": "<string>",
                "relationship": {
                  "definition": "<string>",
                  "limit": 5.5
                }
              }
            ],
            "progress": {
              "found": 123,
              "analyzed": 123,
              "completion": 50,
              "timeLeft": 123
            },
            "recall": {
              "expected": {
                "total": 123,
                "confidence": "high",
                "bounds": {
                  "min": 123,
                  "max": 123
                }
              },
              "reasoning": "<string>"
            },
            "canceledAt": "2023-11-07T05:31:56Z",
            "canceledReason": "webset_deleted",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "behavior": "override",
            "metadata": {}
          }
        ],
        "imports": [
          {
            "id": "<string>",
            "object": "import",
            "status": "pending",
            "format": "csv",
            "entity": {
              "type": "company"
            },
            "title": "<string>",
            "count": 123,
            "metadata": {},
            "failedReason": "invalid_format",
            "failedAt": "2023-11-07T05:31:56Z",
            "failedMessage": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "enrichments": [
          {
            "id": "<string>",
            "object": "webset_enrichment",
            "status": "pending",
            "websetId": "<string>",
            "title": "<string>",
            "description": "<string>",
            "format": "text",
            "options": [
              {
                "label": "<string>"
              }
            ],
            "instructions": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "monitors": [
          {
            "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"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "excludes": [
          {
            "source": "import",
            "id": "<string>"
          }
        ],
        "metadata": {}
      },
      "createdAt": "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
​
types
enum<string>[]

The types of events to filter by

Available options:
webset.created,
webset.deleted,
webset.paused,
webset.idle,
webset.search.created,
webset.search.canceled,
webset.search.completed,
webset.search.updated,
import.created,
import.completed,
webset.item.created,
webset.item.enriched,
monitor.created,
monitor.updated,
monitor.deleted,
monitor.run.created,
monitor.run.completed,
webset.export.created,
webset.export.completed
​
createdBefore
string<date-time>

Filter events created before or at this timestamp (inclusive). Must be a valid ISO 8601 datetime string. All times are in UTC.

​
createdAfter
string<date-time>

Filter events created after or at this timestamp (inclusive). Must be a valid ISO 8601 datetime string. All times are in UTC.

Response

200 - application/json

List of events

​
data
(WebsetCreatedEvent · object | WebsetDeletedEvent · object | WebsetIdleEvent · object | WebsetPausedEvent · object | WebsetItemCreatedEvent · object | WebsetItemEnrichedEvent · object | WebsetSearchCreatedEvent · object | WebsetSearchUpdatedEvent · object | WebsetSearchCanceledEvent · object | WebsetSearchCompletedEvent · object | ImportCreatedEvent · object | ImportCompletedEvent · object | MonitorCreatedEvent · object | MonitorUpdatedEvent · object | MonitorDeletedEvent · object | MonitorRunCreatedEvent · object | MonitorRunCompletedEvent · object)[]
required

The list of events

​
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