Skip to main content
GET
Get analytics overview
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. Optional workflow_id limits the results to one agent.

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

One of: 7d, 30d, custom

timezone
string
required

IANA timezone (e.g., 'America/New_York')

start
string | null

YYYY-MM-DD (required for custom)

end
string | null

YYYY-MM-DD (required for custom)

workflow_id
integer | null

Response

Successful Response

end_utc
string
required
period
string
required
start_utc
string
required
summary
AnalyticsOverviewSummary · object
required
timezone
string
required
workflow_id
integer | null
required