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>"
}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": "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
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, 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 Filter events created before or at this timestamp (inclusive). Must be a valid ISO 8601 datetime string. All times are in UTC.
Filter events created after or at this timestamp (inclusive). Must be a valid ISO 8601 datetime string. All times are in UTC.
Response
List of events
The list of events
- WebsetCreatedEvent
- WebsetDeletedEvent
- WebsetIdleEvent
- WebsetPausedEvent
- WebsetItemCreatedEvent
- WebsetItemEnrichedEvent
- WebsetSearchCreatedEvent
- WebsetSearchUpdatedEvent
- WebsetSearchCanceledEvent
- WebsetSearchCompletedEvent
- ImportCreatedEvent
- ImportCompletedEvent
- MonitorCreatedEvent
- MonitorUpdatedEvent
- MonitorDeletedEvent
- MonitorRunCreatedEvent
- MonitorRunCompletedEvent
Show child attributes
Show child attributes
The unique identifier for the event
"event""webset.created"Show child attributes
Show child attributes
The unique identifier for the webset
"webset"The status of the webset
idle, pending, running, paused The external identifier for the webset
The title of the webset
The searches that have been performed on the webset.
Show child attributes
Show child attributes
The unique identifier for the search
"webset_search"The status of the search
created, pending, running, completed, canceled The unique identifier for the Webset this search belongs to
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
- Person
- Article
- Research Paper
- Custom
Show child attributes
Show child attributes
"company"The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you.
Show child attributes
Show child attributes
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 >= 1The scope of the search. By default, there is no scope - thus searching the web.
If provided during creation, the search will only be performed on the sources provided.
Show child attributes
Show child attributes
import, webset The progress of the search
Show child attributes
Show child attributes
The number of results found so far
The number of results analyzed so far
The completion percentage of the search
0 <= x <= 100The estimated time remaining in seconds, null if unknown
Recall metrics for the search, null if not yet computed or requested.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The estimated total number of potential matches
The confidence in the estimate
high, medium, low The reasoning for the estimate
The 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 behavior of the search when it is added to a Webset.
override: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.append: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
override, append Imports that have been performed on the webset.
Show child attributes
Show child attributes
The unique identifier for the Import
The type of object
import The status of the Import
pending, processing, completed, failed The format of the import.
csv, webset The title of the import
The number of entities in the import
The reason the import failed
invalid_format, invalid_file_content, missing_identifier When the import failed
A human readable message of the import failure
When the import was created
When the import was last updated
The Enrichments to apply to the Webset Items.
Show child attributes
Show child attributes
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, url The instructions for the enrichment Agent.
This will be automatically generated based on the description and format.
The date and time the enrichment was created
The date and time the enrichment was updated
The Monitors for the Webset.
Show child attributes
Show child attributes
The unique identifier for the Monitor
The type of object
monitor The status of the Monitor
enabled, disabled The id of the Webset the Monitor belongs to
How often the monitor will run
Behavior to perform when monitor runs
Show child attributes
Show child attributes
"search"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
Show child attributes
The maximum number of results to find
The query to search for. By default, the query from the last search is used.
2 - 10000The entity to search for. By default, the entity from the last search/import is used.
- Company
- Person
- Article
- Research Paper
- Custom
Show child attributes
Show child attributes
"company"The behaviour of the Search when it is added to a Webset.
override, append The last run of the monitor
Show child attributes
Show child attributes
The unique identifier for the Monitor Run
The type of object
monitor_run The status of the Monitor Run
created, running, completed, canceled, failed The monitor that the run is associated with
The type of the Monitor Run
search, refresh When the run completed
When the run failed
The reason the run failed
When the run was canceled
When the run was created
When the run was last updated
Date and time when the next run will occur in
When the monitor was created
When the monitor was last updated
The date and time the webset was created
The date and time the webset was updated
The Excludes sources (existing imports or websets) that apply to all operations within this Webset. Any results found within these sources will be omitted across all search and import operations.
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