List task queues statistics

GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics

TODO: Resource-level docs

Path parameters

WorkspaceSid string Required

The SID of the Workspace with the TaskQueues to read.

Query parameters

EndDate string(date-time)

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

The friendly_name of the TaskQueue statistics to read.
Minutes integer

Only calculate statistics since this many minutes in the past. The default is 15 minutes.
StartDate string(date-time)

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

Only calculate 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.
PageSize integer

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum value is 1, maximum value is 1000.

Responses

200

OK
Hide response attributes Show response attributes object
- meta object
  
  Hide meta attributes Show meta attributes object
  
  first_page_url string(uri)
  
  key string
  
  next_page_url string(uri)
  
  page integer
  
  page_size integer
  
  previous_page_url string(uri)
  
  url string(uri)
- task_queues_statistics array[object]
  
  Hide task_queues_statistics attributes Show task_queues_statistics attributes array[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}$.
  
  cumulative
  
  An object that contains the cumulative statistics for the TaskQueues
  
  realtime
  
  An object that contains the real-time statistics for the TaskQueues
  
  task_queue_sid string | null
  
  The SID of the TaskQueue from which these statistics were calculated
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WQ[0-9a-fA-F]{32}$.
  
  workspace_sid string | null
  
  The SID of the Workspace that contains the TaskQueues
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics

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

Response examples (200)

{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "task_queues_statistics": [
    {
      "account_sid": "string",
      "task_queue_sid": "string",
      "workspace_sid": "string"
    }
  ]
}

Response examples (200)

{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "task_queues_statistics": [
    {
      "account_sid": "string",
      "task_queue_sid": "string",
      "workspace_sid": "string"
    }
  ]
}