List all Events
List all events that have occurred in the system.
You can paginate through the results using the cursor parameter.
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,
"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"
}
],
"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
1The number of results to return
1 <= x <= 200The types of events to filter by
webset.created, webset.deleted, webset.paused, webset.idle, webset.search.created, webset.search.canceled, webset.search.completed, webset.search.updated, webset.export.created, webset.export.completed, webset.item.created, webset.item.enriched Response
The list of events
The unique identifier for the event
"event""webset.created"The unique identifier for the webset
"webset"The status of the webset
idle, running, paused The external identifier for the webset
The searches that have been performed on the webset.
The unique identifier for the search
"webset_search"The status of the search
created, running, completed, canceled The query used to create the search.
1 - 5000The entity the search will return results for.
When no entity is provided during creation, we will automatically select the best entity based on the query.
"company"The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you.
The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.
x >= 1Set of key-value pairs you want to associate with this object.
1000The date and time the search was canceled
The reason the search was canceled
webset_deleted, webset_canceled The date and time the search was created
The date and time the search was updated
The Enrichments to apply to the Webset Items.
The unique identifier for the enrichment
"webset_enrichment"The status of the enrichment
pending, canceled, completed The unique identifier for the Webset this enrichment belongs to.
The title of the enrichment.
This will be automatically generated based on the description and format.
The description of the enrichment task provided during the creation of the enrichment.
The format of the enrichment response.
text, date, number, options, email, phone When the format is options, the different options for the enrichment agent to choose from.
The label of the option
The instructions for the enrichment Agent.
This will be automatically generated based on the description and format.
The metadata of the enrichment
1000The date and time the enrichment was created
The date and time the enrichment was updated
Set of key-value pairs you want to associate with this object.
1000The date and time the webset was created
The date and time the webset was updated
The date and time the event was created
Whether there are more results to paginate through
The cursor to paginate through the next set of results
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,
"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"
}
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "<string>"
}