Skip to main content
GET
Get provider usage
Supply an IANA timezone, such as Europe/Dublin. Use period=7d or 30d, or custom with start and end in YYYY-MM-DD format. Invalid periods/date ranges return 400. Use the same range and timezone across related charts. Optionally filter by agent. Read the response units before comparing provider totals.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Query Parameters

period
string
default:7d
timezone
string
required
start
string | null
end
string | null
workflow_id
integer | null

Response

Successful Response

call_types
AnalyticsProviderItem · object[]
required
modes
AnalyticsProviderItem · object[]
required
period
string
required