Fetch workflow real time statistics

GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the Workflow to fetch.

  • WorkflowSid string Required

    Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.

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

    • 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

    • url string(uri) | null

      The absolute URL of the Workflow statistics resource

    • workflow_sid string | null

      Returns the list of Tasks that are being controlled by the Workflow with the specified SID value

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

    • workspace_sid string | null

      The SID of the Workspace that contains the Workflow.

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

GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "longest_task_waiting_age": 42,
  "longest_task_waiting_sid": "string",
  "total_tasks": 42,
  "url": "https://example.com",
  "workflow_sid": "string",
  "workspace_sid": "string"
}
Response examples (200)
{
  "account_sid": "string",
  "longest_task_waiting_age": 42,
  "longest_task_waiting_sid": "string",
  "total_tasks": 42,
  "url": "https://example.com",
  "workflow_sid": "string",
  "workspace_sid": "string"
}