github.com/twilio/twilio-go@v1.20.1/rest/taskrouter/v1/docs/WorkspacesWorkersStatisticsApi.md (about)

     1  # WorkspacesWorkersStatisticsApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchWorkerInstanceStatistics**](WorkspacesWorkersStatisticsApi.md#FetchWorkerInstanceStatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics | 
     8  [**FetchWorkerStatistics**](WorkspacesWorkersStatisticsApi.md#FetchWorkerStatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/Statistics | 
     9  
    10  
    11  
    12  ## FetchWorkerInstanceStatistics
    13  
    14  > TaskrouterV1WorkerInstanceStatistics FetchWorkerInstanceStatistics(ctx, WorkspaceSidWorkerSidoptional)
    15  
    16  
    17  
    18  
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerChannel to fetch.
    27  **WorkerSid** | **string** | The SID of the Worker with the WorkerChannel to fetch.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a FetchWorkerInstanceStatisticsParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  **Minutes** | **int** | 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.
    37  **StartDate** | **time.Time** | Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    38  **EndDate** | **time.Time** | Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
    39  **TaskChannel** | **string** | Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
    40  
    41  ### Return type
    42  
    43  [**TaskrouterV1WorkerInstanceStatistics**](TaskrouterV1WorkerInstanceStatistics.md)
    44  
    45  ### Authorization
    46  
    47  [accountSid_authToken](../README.md#accountSid_authToken)
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: Not defined
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57  
    58  
    59  ## FetchWorkerStatistics
    60  
    61  > TaskrouterV1WorkerStatistics FetchWorkerStatistics(ctx, WorkspaceSidoptional)
    62  
    63  
    64  
    65  
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **WorkspaceSid** | **string** | The SID of the Workspace with the Worker to fetch.
    74  
    75  ### Other Parameters
    76  
    77  Other parameters are passed through a pointer to a FetchWorkerStatisticsParams struct
    78  
    79  
    80  Name | Type | Description
    81  ------------- | ------------- | -------------
    82  **Minutes** | **int** | 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.
    83  **StartDate** | **time.Time** | Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    84  **EndDate** | **time.Time** | Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
    85  **TaskQueueSid** | **string** | The SID of the TaskQueue for which to fetch Worker statistics.
    86  **TaskQueueName** | **string** | The `friendly_name` of the TaskQueue for which to fetch Worker statistics.
    87  **FriendlyName** | **string** | Only include Workers with `friendly_name` values that match this parameter.
    88  **TaskChannel** | **string** | Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
    89  
    90  ### Return type
    91  
    92  [**TaskrouterV1WorkerStatistics**](TaskrouterV1WorkerStatistics.md)
    93  
    94  ### Authorization
    95  
    96  [accountSid_authToken](../README.md#accountSid_authToken)
    97  
    98  ### HTTP request headers
    99  
   100  - **Content-Type**: Not defined
   101  - **Accept**: application/json
   102  
   103  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   104  [[Back to Model list]](../README.md#documentation-for-models)
   105  [[Back to README]](../README.md)
   106