Guides
Filtering and Pagination
Date ranges, aggregation, and page tokens.
Filters are sent as query parameters.
Date ranges
Use one range at a time:
| Query parameter pair | Applies to |
|---|---|
startedAtFrom, startedAtTo | Event start time |
endedAtFrom, endedAtTo | Event end time |
Values must be RFC3339 UTC timestamps ending in Z. A range cannot exceed 3 months.
curl "https://data-api.hivestreaming.com/ina/v1/events/sessions?startedAtFrom=2026-05-01T00:00:00Z&startedAtTo=2026-05-31T23:59:59Z" \
-H "Authorization: Bearer $IDA_BEARER_TOKEN" \
-H "platform-id: $IDA_PLATFORM_ID" \
-H "tenant-id: $IDA_TENANT_ID"Sorting
GET /v1/events/sessions also accepts:
| Query parameter | Values | Default |
|---|---|---|
orderBy | startedAt, endedAt | startedAt |
orderAsc | true, false | true |
Aggregation
Use the aggr query parameter on GET /v1/events/sessions, GET /v1/events/sessions/{eventSessionId}, and GET /v1/events/sessions/{eventSessionId}/sites. It isn't available on the viewers endpoint.
Allowed values:
latest
cumulativePagination
When a response includes pagination, pass its value as the next request's cursor query parameter.