Fetch workspace real time statistics

GET /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics

TODO: Resource-level docs

Path parameters

Query parameters

  • TaskChannel string

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

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}$.

    • activity_statistics array | null

      The number of current Workers by Activity

    • longest_task_waiting_age integer | null

      The age of the longest waiting Task

    • longest_task_waiting_sid string | null

      The SID of the longest waiting Task

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

    • tasks_by_priority

      The number of Tasks by priority

    • tasks_by_status

      The number of Tasks by their current status

    • total_tasks integer | null

      The total number of Tasks

    • total_workers integer | null

      The total number of Workers in the Workspace

    • url string(uri) | null

      The absolute URL of the Workspace statistics resource

    • 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}/RealTimeStatistics 
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/RealTimeStatistics \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "activity_statistics": [],
  "longest_task_waiting_age": 42,
  "longest_task_waiting_sid": "string",
  "total_tasks": 42,
  "total_workers": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}
Response examples (200) 
{
  "account_sid": "string",
  "activity_statistics": [],
  "longest_task_waiting_age": 42,
  "longest_task_waiting_sid": "string",
  "total_tasks": 42,
  "total_workers": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}