GET
/
events
/
volume
Get event volume
curl --request GET \
  --url https://api.withorb.com/v1/events/volume \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "timeframe_start": "2023-11-07T05:31:56Z",
      "timeframe_end": "2023-11-07T05:31:56Z",
      "count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
timeframe_start
string<date-time>
required

The start of the timeframe, inclusive, in which to return event volume. All datetime values are converted to UTC time. If the specified time isn't hour-aligned, the response includes the event volume count for the hour the time falls in.

​
timeframe_end
string<date-time>

The end of the timeframe, exclusive, in which to return event volume. If not specified, the current time is used. All datetime values are converted to UTC time.If the specified time isn't hour-aligned, the response includes the event volumecount for the hour the time falls in.

Examples:

"2024-10-11T06:00:00Z"

Response

200
application/json

OK

The response is of type object.