Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-056136556.2 KB
TaskrouterV1WorkersStatistics

get/v1/Workspaces/{WorkspaceSid}/Workers/Statistics

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the Worker to fetch.

Query parameters

Minutesinteger

Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.

StartDatestring date-time

Only calculate statistics from this date and time and later, specified in ISO 8601 format.

EndDatestring date-time

Only calculate statistics from this date and time and earlier, specified in GMT as an ISO 8601 date-time.

TaskQueueSidstring

The SID of the TaskQueue for which to fetch Worker statistics.

TaskQueueNamestring

The friendly_name of the TaskQueue for which to fetch Worker statistics.

FriendlyNamestring

Only include Workers with friendly_name values that match this parameter.

TaskChannelstring

Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its unique_name, such as voice, sms, or default.

Response

OK

{"stackTrail":"components:schemas:taskrouter.v1.workspace.worker.worker_statistics:properties:realtime","oasType":"schema","type":"unknown","description":"An object that contains the real-time statistics for the Worker.","nullable":true}
{"stackTrail":"components:schemas:taskrouter.v1.workspace.worker.worker_statistics:properties:cumulative","oasType":"schema","type":"unknown","description":"An object that contains the cumulative statistics for the Worker.","nullable":true}
account_sidstring nullable

The SID of the Account that created the Worker resource.

workspace_sidstring nullable

The SID of the Workspace that contains the Worker.

urlstring uri nullable

The absolute URL of the Worker statistics resource.