Fetch worker instance statistics

GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the WorkerChannel to fetch.

  • WorkerSid string Required

    The SID of the Worker with the WorkerChannel to fetch.

Query parameters

  • Minutes integer

    Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.

  • StartDate string(date-time)

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

  • EndDate string(date-time)

    Only include usage that occurred on or before this date, specified in GMT as an ISO 8601 date-time.

  • TaskChannel string

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

    • cumulative

      An object that contains the cumulative statistics for the Worker

    • url string(uri) | null

      The absolute URL of the WorkerChannel statistics resource

    • worker_sid string | null

      The SID of the Worker that contains the WorkerChannel

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

    • workspace_sid string | null

      The SID of the Workspace that contains the WorkerChannel

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics 
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "url": "https://example.com",
  "worker_sid": "string",
  "workspace_sid": "string"
}
Response examples (200) 
{
  "account_sid": "string",
  "url": "https://example.com",
  "worker_sid": "string",
  "workspace_sid": "string"
}