Skip to main content
POST
/
events
/
search
Search events
curl --request POST \
  --url https://api.withorb.com/v1/events/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_ids": [
    "<string>"
  ],
  "timeframe_start": "2023-11-07T05:31:56Z",
  "timeframe_end": "2023-11-07T05:31:56Z"
}
'
{
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "external_customer_id": "<string>",
      "event_name": "<string>",
      "properties": {},
      "timestamp": "2023-11-07T05:31:56Z",
      "deprecated": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Body

application/json
​
event_ids
string[]
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.

Required array length: 1 - 500 elements
​
timeframe_start
string<date-time> | null

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

​
timeframe_end
string<date-time> | null

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

Response

OK

​
data
Event · object[]
required