Fetch worker instance statistics

GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics
Account sid auth token

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the WorkerChannel to fetch.

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

  • WorkerSid string Required

    The SID of the Worker with the WorkerChannel to fetch.

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

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 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 Worker 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.

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

    • url string(uri) | null

      The absolute URL of the WorkerChannel statistics resource.
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics 
curl \
 --request GET 'https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics",
  "cumulative": {
    "end_time": "2008-01-02T00:00:00Z",
    "start_time": "2008-01-02T00:00:00Z",
    "activity_durations": [
      {
        "avg": 1080,
        "max": 0,
        "min": 900,
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "total": 5400,
        "friendly_name": "Offline"
      },
      {
        "avg": 1012,
        "max": 0,
        "min": 900,
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "total": 8100,
        "friendly_name": "Busy"
      },
      {
        "avg": 0,
        "max": 0,
        "min": 0,
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "total": 0,
        "friendly_name": "Idle"
      },
      {
        "avg": 0,
        "max": 0,
        "min": 0,
        "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "total": 0,
        "friendly_name": "Reserved"
      }
    ],
    "reservations_created": 100,
    "reservations_accepted": 100,
    "reservations_canceled": 100,
    "reservations_rejected": 100,
    "reservations_rescinded": 100,
    "reservations_timed_out": 100
  },
  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}