Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use a server-side Brightalk API key in the Authorization header.

Headers

Brightalk-Version
string
default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned default.

Allowed value: "2026-07-16"
X-Request-Id
string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$

Query Parameters

start_at
string<date-time>
required

Inclusive start or exclusive end timestamp.

end_at
string<date-time>
required

Inclusive start or exclusive end timestamp.

group_by
string

Up to three metadata keys, comma-separated.

metadata
string

JSON string map of metadata filters.

Response

Successful response.

start_at
string
required
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
end_at
string
required
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
period_basis
string
required
Allowed value: "execution_created_at"
data
object[]
required
voice_credit_accounting
string
required
Allowed value: "settled_period_proportional_minutes"
voice_credit_unit
string
required
Allowed value: "minutes"
voice_credit_periods
object[]
required
voice_minute_rounding
string
required
Allowed value: "duration_seconds / 60"