Get an event

Get a single Event by id.

You can subscribe to Events by creating a Webhook.

Get an Event

cURL

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

200

{
  "id": "<string>",
  "object": "event",
  "data": {
    "id": "<string>",
    "object": "webset",
    "status": "idle",
    "externalId": "<string>",
    "title": "<string>",
    "searches": [
      {
        "id": "<string>",
        "object": "webset_search",
        "websetId": "<string>",
        "status": "created",
        "query": "<string>",
        "entity": {
          "type": "company"
        },
        "criteria": [
          {
            "description": "<string>",
            "successRate": 50
          }
        ],
        "count": 2,
        "maxPeoplePerCompany": 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": {
          "config": {
            "count": 123,
            "query": "<string>",
            "criteria": [
              {
                "description": "<string>"
              }
            ],
            "entity": {
              "type": "company"
            },
            "behavior": "append"
          },
          "type": "search"
        },
        "lastRun": {
          "id": "<string>",
          "object": "monitor_run",
          "monitorId": "<string>",
          "status": "created",
          "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",
          "type": "search"
        },
        "nextRunAt": "2023-11-07T05:31:56Z",
        "metadata": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "dashboardUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "excludes": [
      {
        "source": "import",
        "id": "<string>"
      }
    ],
    "metadata": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "webset.created"
}

Authorizations

apiKeybearer

x-api-key · string · header · required

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

Path Parameters

id · string · required

The id of the event

Response

200

application/json

WebsetCreatedEvent

WebsetDeletedEvent

WebsetIdleEvent

WebsetPausedEvent

WebsetItemCreatedEvent

WebsetItemEnrichedEvent

WebsetSearchCreatedEvent

WebsetSearchUpdatedEvent

WebsetSearchCanceledEvent

WebsetSearchCompletedEvent

ImportCreatedEvent

ImportCompletedEvent

MonitorCreatedEvent

MonitorUpdatedEvent

MonitorDeletedEvent

MonitorRunCreatedEvent

MonitorRunCompletedEvent

id · string · required

The unique identifier for the event

object · string · default: event · required

The type of object

Allowed value: "event"

data · object · required

Show child attributes

createdAt · string<date-time> · required

The date and time the event was created

type · string · default: webset.created · required

The type of event

Allowed value: "webset.created"