Search events
This endpoint returns a filtered set of events for an account in a paginated list format.
Note that this is a POST endpoint rather than a GET endpoint because it employs a JSON body for search criteria
rather than query parameters, allowing for a more flexible search syntax.
Note that a search criteria must be specified. Currently, Orb supports the following criteria:
event_ids: This is an explicit array of IDs to filter by. Note that an event’s ID is theidempotency_keythat was originally used for ingestion.
By default, Orb will not throw a 404 if no events matched, Orb will return an empty array for data instead.
Authorizations
API Keys can be issued in the Orb's web application.
Body
This is an explicit array of IDs to filter by. Note that an event's ID is the idempotency_key that was originally used for ingestion, and this only supports events that have not been amended. Values in this array will be treated case sensitively.
The start of the timeframe, inclusive, in which to search events. If not specified, the one week ago is used.
The end of the timeframe, exclusive, in which to search events. If not specified, the current time is used.
Response
Was this page helpful?