Skip to main content
GET
List analytics runs
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. Pages start at 1, with limit defaulting to 25 and capped at 100. Optional filters include agent, search text, run state, and call type. The response combines page records with summary information.

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

timezone
string
required
period
string
default:30d
start
string | null
end
string | null
workflow_id
integer | null
Required range: x >= 1
page
integer
default:1
Required range: x >= 1
limit
integer
default:25
Required range: 1 <= x <= 100
Maximum string length: 200
state
enum<string> | null
Available options:
initialized,
running,
completed
call_type
enum<string> | null
Available options:
inbound,
outbound

Response

Successful Response

limit
integer
required
page
integer
required
runs
AnalyticsRunItem · object[]
required
summary
AnalyticsRunSummary · object
required