Events
List all Events
List all events that have occurred in the system.
You can paginate through the results using the cursor
parameter.
GET
/
v0
/
events
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": "<string>",
"status": "idle",
"externalId": "<string>",
"searches": [
{
"id": "<string>",
"object": "<string>",
"status": "created",
"query": "<string>",
"entity": {
"type": "<string>"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"behavior": "override",
"progress": {
"found": 123,
"completion": 50
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"enrichments": [
{
"id": "<string>",
"object": "<string>",
"status": "pending",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"format": "text",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"streams": [
{
"id": "<string>",
"object": "stream",
"status": "open",
"websetId": "<string>",
"cadence": {
"cron": "<string>",
"timezone": "<string>"
},
"behavior": {
"type": "<string>",
"config": {
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "<string>"
},
"count": 1,
"behavior": "override"
}
},
"lastRun": {
"id": "<string>",
"object": "stream_run",
"status": "created",
"streamId": "<string>",
"type": "search",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"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"
}
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "<string>"
}
Authorizations
Your Exa API key
Query Parameters
The cursor to paginate through the results
Minimum length:
1
The number of results to return
Required range:
1 <= x <= 200
The types of events to filter by
Response
200 - application/json
List of events
The response is of type object
.
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": "<string>",
"status": "idle",
"externalId": "<string>",
"searches": [
{
"id": "<string>",
"object": "<string>",
"status": "created",
"query": "<string>",
"entity": {
"type": "<string>"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"behavior": "override",
"progress": {
"found": 123,
"completion": 50
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"enrichments": [
{
"id": "<string>",
"object": "<string>",
"status": "pending",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"format": "text",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"streams": [
{
"id": "<string>",
"object": "stream",
"status": "open",
"websetId": "<string>",
"cadence": {
"cron": "<string>",
"timezone": "<string>"
},
"behavior": {
"type": "<string>",
"config": {
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "<string>"
},
"count": 1,
"behavior": "override"
}
},
"lastRun": {
"id": "<string>",
"object": "stream_run",
"status": "created",
"streamId": "<string>",
"type": "search",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"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"
}
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.