Skip to main content
GET
Rank agents for a reporting period
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. limit defaults to 5 and is capped at 20.

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
limit
integer
default:5
Required range: 1 <= x <= 20
start
string | null
end
string | null

Response

Successful Response

period
string
required
workflows
AnalyticsTopWorkflowItem · object[]
required