v1

latestOpenAPI 3.1.02026-07-261444991.2 MB

Event

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 the idempotency_key that 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.

post/events/search

Request body

event_idsstring[] required

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.

timeframe_startstring date-time nullable

The start of the timeframe, inclusive, in which to search events. If not specified, the one week ago is used.

timeframe_endstring date-time nullable

The end of the timeframe, exclusive, in which to search events. If not specified, the current time is used.

Response

Example response

{
  "data": [
    {
      "timestamp": "2020-12-09T16:09:53Z"
    }
  ]
}