---
title: "Get event volume"
method: GET
path: "/events/volume"
tags: ["Event"]
---

# Get event volume

`GET /events/volume`

This endpoint returns the event volume for an account in a [paginated list format](/api-reference/pagination).

The event volume is aggregated by the hour and the [timestamp](/api-reference/event/ingest-events)
field is used to determine which hour an event is associated with. Note, this means that late-arriving events
increment the volume count for the hour window the timestamp is in, not the latest hour window.

Each item in the response contains the count of events aggregated by the hour
where the start and end time are hour-aligned and in UTC. When a specific timestamp is passed
in for either start or end time, the response includes the hours the timestamp falls in.

## Query parameters

- `limit` integer — The number of items to fetch. Defaults to 20.
- `cursor` string, nullable — 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.

## Response `200`

OK

- EventVolumes
  - `data` EventVolume[], required
    - `timeframe_start` string, date-time, required
    - `timeframe_end` string, date-time, required
    - `count` integer, required — The number of events ingested with a timestamp between the timeframe

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `409` — Conflict
- `413` — Content Too Large
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/orbcorp/apis/api-reference.md) · [All operations](https://skmtc.dev/orbcorp/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orbcorp/api-reference/revisions/2580a0ee8d4c/schema)