TWtwilio
TaskrouterV1TaskQueueCumulativeStatistics

Changed on
get/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics

Request

  • Base URL
    https://taskrouter.twilio.com
  • URL
    https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics
  • Auth
    HTTP basic

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the TaskQueue to fetch.

TaskQueueSidstring required

The SID of the TaskQueue for which to fetch statistics.

Query parameters

EndDatestring date-time

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

Minutesinteger

Only calculate statistics since this many minutes in the past. The default is 15 minutes.

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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.

Response

OK

account_sidstring nullable

The SID of the Account that created the TaskQueue 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 created for Tasks in the TaskQueue.

reservations_acceptedinteger

The total number of Reservations accepted for Tasks in the TaskQueue.

reservations_rejectedinteger

The total number of Reservations rejected for Tasks in the TaskQueue.

reservations_timed_outinteger

The total number of Reservations that timed out for Tasks in the TaskQueue.

reservations_canceledinteger

The total number of Reservations canceled for Tasks in the TaskQueue.

reservations_rescindedinteger

The total number of Reservations rescinded.

split_by_wait_timeunknown
task_queue_sidstring nullable

The SID of the TaskQueue from which these statistics were calculated.

wait_duration_until_acceptedunknown
wait_duration_until_canceledunknown
wait_duration_in_queue_until_acceptedunknown
tasks_canceledinteger

The total number of Tasks canceled in the TaskQueue.

tasks_completedinteger

The total number of Tasks completed in the TaskQueue.

tasks_deletedinteger

The total number of Tasks deleted in the TaskQueue.

tasks_enteredinteger

The total number of Tasks entered into the TaskQueue.

tasks_movedinteger

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

workspace_sidstring nullable

The SID of the Workspace that contains the TaskQueue.

urlstring uri nullable

The absolute URL of the TaskQueue statistics resource.

Changes

  • v198aedcadea73Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

  • v14e6af3af0c51Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status