POST
/
events
/
search
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": "2020-12-09T16:09:53Z",
      "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.

​
timeframe_start
string | null

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

​
timeframe_end
string | null

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

Response

200
application/json
OK
​
data
object[]
required

The Event resource represents a usage event that has been created for a customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for a given billing period.

Was this page helpful?

Revert backfillGet event volume