Fetch task queue statistics

GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics
Account sid auth token

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the TaskQueue to fetch.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

  • TaskQueueSid string Required

    The SID of the TaskQueue for which to fetch statistics.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WQ[0-9a-fA-F]{32}$.

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.

  • 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 real-time and cumulative statistics for the specified 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.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

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

    • realtime

      An object that contains the real-time statistics for the TaskQueue.

    • 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 TaskQueue.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

    • url string(uri) | null

      The absolute URL of the TaskQueue statistics resource.
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics 
curl \
 --request GET 'https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics",
  "realtime": {
    "total_tasks": 0,
    "tasks_by_status": {
      "pending": 0,
      "assigned": 0,
      "reserved": 0,
      "wrapping": 0
    },
    "activity_statistics": [
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "Offline"
      },
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "Idle"
      },
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73"
      },
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "Reserved"
      },
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "Busy"
      },
      {
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "workers": 0,
        "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73"
      }
    ],
    "total_eligible_workers": 0,
    "total_available_workers": 0,
    "longest_task_waiting_age": 0,
    "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "cumulative": {
    "end_time": "2015-08-18T08:42:34Z",
    "start_time": "2015-08-18T08:27:34Z",
    "tasks_moved": 0,
    "tasks_deleted": 0,
    "tasks_entered": 0,
    "tasks_canceled": 0,
    "reservations_created": 0,
    "reservations_accepted": 0,
    "reservations_canceled": 0,
    "reservations_rejected": 0,
    "reservations_rescinded": 0,
    "reservations_timed_out": 0,
    "avg_task_acceptance_time": 0
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}