Fetch workspace cumulative statistics

GET /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics

TODO: Resource-level docs

Path parameters

WorkspaceSid string Required

The SID of the Workspace to fetch.

Query parameters

EndDate string(date-time)

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

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.
StartDate string(date-time)

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

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

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.

Responses

200

OK
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- avg_task_acceptance_time integer | null
  
  The average time in seconds between Task creation and acceptance
- end_time string(date-time) | null
  
  The end of the interval during which these statistics were calculated
- reservations_accepted integer | null
  
  The total number of Reservations accepted by Workers
- reservations_canceled integer | null
  
  The total number of Reservations that were canceled
- reservations_created integer | null
  
  The total number of Reservations that were created for Workers
- reservations_rejected integer | null
  
  The total number of Reservations that were rejected
- reservations_rescinded integer | null
  
  The total number of Reservations that were rescinded
- reservations_timed_out integer | null
  
  The total number of Reservations that were timed out
- split_by_wait_time
  
  A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
- start_time string(date-time) | null
  
  The beginning of the interval during which these statistics were calculated
- tasks_canceled integer | null
  
  The total number of Tasks that were canceled
- tasks_completed integer | null
  
  The total number of Tasks that were completed
- tasks_created integer | null
  
  The total number of Tasks created
- tasks_deleted integer | null
  
  The total number of Tasks that were deleted
- tasks_moved integer | null
  
  The total number of Tasks that were moved from one queue to another
- tasks_timed_out_in_workflow integer | null
  
  The total number of Tasks that were timed out of their Workflows
- url string(uri) | null
  
  The absolute URL of the Workspace statistics resource
- wait_duration_until_accepted
  
  The wait duration statistics for Tasks that were accepted
- wait_duration_until_canceled
  
  The wait duration statistics for Tasks that were canceled
- workspace_sid string | null
  
  The SID of the Workspace
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

GET /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics

curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/CumulativeStatistics \
 --user "username:password"

Response examples (200)

{
  "account_sid": "string",
  "avg_task_acceptance_time": 42,
  "end_time": "2023-05-04T09:42:00+00:00",
  "reservations_accepted": 42,
  "reservations_canceled": 42,
  "reservations_created": 42,
  "reservations_rejected": 42,
  "reservations_rescinded": 42,
  "reservations_timed_out": 42,
  "start_time": "2023-05-04T09:42:00+00:00",
  "tasks_canceled": 42,
  "tasks_completed": 42,
  "tasks_created": 42,
  "tasks_deleted": 42,
  "tasks_moved": 42,
  "tasks_timed_out_in_workflow": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}

Response examples (200)

{
  "account_sid": "string",
  "avg_task_acceptance_time": 42,
  "end_time": "2024-05-04T09:42:00+00:00",
  "reservations_accepted": 42,
  "reservations_canceled": 42,
  "reservations_created": 42,
  "reservations_rejected": 42,
  "reservations_rescinded": 42,
  "reservations_timed_out": 42,
  "start_time": "2024-05-04T09:42:00+00:00",
  "tasks_canceled": 42,
  "tasks_completed": 42,
  "tasks_created": 42,
  "tasks_deleted": 42,
  "tasks_moved": 42,
  "tasks_timed_out_in_workflow": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}