Sign in

v50

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

get/v1/Workspaces/{WorkspaceSid}/CumulativeStatistics

Path parameters

WorkspaceSidstring required

The SID of the Workspace to fetch.

Query parameters

EndDatestring date-time

Only include usage that occurred on or before this date, specified in GMT as an ISO 8601 date-time.

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.

TaskChannelstring

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

SplitByWaitTimestring

A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, 5,30 would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA. TaskRouter will calculate statistics on up to 10,000 Tasks for any given threshold.

Response

OK

account_sidstring nullable

The SID of the Account that created the Workspace resource.

avg_task_acceptance_timeinteger

The average time in seconds between Task creation and acceptance.

start_timestring date-time nullable

The beginning of the interval during which these statistics were calculated, in ISO 8601 format.

end_timestring date-time nullable

The end of the interval during which these statistics were calculated, in ISO 8601 format.

reservations_createdinteger

The total number of Reservations that were created for Workers.

reservations_acceptedinteger

The total number of Reservations accepted by Workers.

reservations_rejectedinteger

The total number of Reservations that were rejected.

reservations_timed_outinteger

The total number of Reservations that were timed out.

reservations_canceledinteger

The total number of Reservations that were canceled.

reservations_rescindedinteger

The total number of Reservations that were rescinded.

{"stackTrail":"components:schemas:taskrouter.v1.workspace.workspace_cumulative_statistics:properties:split_by_wait_time","oasType":"schema","type":"unknown","description":"A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.","nullable":true}
{"stackTrail":"components:schemas:taskrouter.v1.workspace.workspace_cumulative_statistics:properties:wait_duration_until_accepted","oasType":"schema","type":"unknown","description":"The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were accepted.","nullable":true}
{"stackTrail":"components:schemas:taskrouter.v1.workspace.workspace_cumulative_statistics:properties:wait_duration_until_canceled","oasType":"schema","type":"unknown","description":"The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were canceled.","nullable":true}
tasks_canceledinteger

The total number of Tasks that were canceled.

tasks_completedinteger

The total number of Tasks that were completed.

tasks_createdinteger

The total number of Tasks created.

tasks_deletedinteger

The total number of Tasks that were deleted.

tasks_movedinteger

The total number of Tasks that were moved from one queue to another.

tasks_timed_out_in_workflowinteger

The total number of Tasks that were timed out of their Workflows (and deleted).

workspace_sidstring nullable

The SID of the Workspace.

urlstring uri nullable

The absolute URL of the Workspace statistics resource.