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

     1  # WorkspacesEventsApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchEvent**](WorkspacesEventsApi.md#FetchEvent) | **Get** /v1/Workspaces/{WorkspaceSid}/Events/{Sid} | 
     8  [**ListEvent**](WorkspacesEventsApi.md#ListEvent) | **Get** /v1/Workspaces/{WorkspaceSid}/Events | 
     9  
    10  
    11  
    12  ## FetchEvent
    13  
    14  > TaskrouterV1Event FetchEvent(ctx, WorkspaceSidSid)
    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 Event to fetch.
    27  **Sid** | **string** | The SID of the Event resource to fetch.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a FetchEventParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  
    37  ### Return type
    38  
    39  [**TaskrouterV1Event**](TaskrouterV1Event.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## ListEvent
    56  
    57  > []TaskrouterV1Event ListEvent(ctx, WorkspaceSidoptional)
    58  
    59  
    60  
    61  
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **WorkspaceSid** | **string** | The SID of the Workspace with the Events to read. Returns only the Events that pertain to the specified Workspace.
    70  
    71  ### Other Parameters
    72  
    73  Other parameters are passed through a pointer to a ListEventParams struct
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  **EndDate** | **time.Time** | Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
    79  **EventType** | **string** | The type of Events to read. Returns only Events of the type specified.
    80  **Minutes** | **int** | The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted.
    81  **ReservationSid** | **string** | The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.
    82  **StartDate** | **time.Time** | Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted.
    83  **TaskQueueSid** | **string** | The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.
    84  **TaskSid** | **string** | The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.
    85  **WorkerSid** | **string** | The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.
    86  **WorkflowSid** | **string** | The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.
    87  **TaskChannel** | **string** | The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.
    88  **Sid** | **string** | The SID of the Event resource to read.
    89  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    90  **Limit** | **int** | Max number of records to return.
    91  
    92  ### Return type
    93  
    94  [**[]TaskrouterV1Event**](TaskrouterV1Event.md)
    95  
    96  ### Authorization
    97  
    98  [accountSid_authToken](../README.md#accountSid_authToken)
    99  
   100  ### HTTP request headers
   101  
   102  - **Content-Type**: Not defined
   103  - **Accept**: application/json
   104  
   105  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   106  [[Back to Model list]](../README.md#documentation-for-models)
   107  [[Back to README]](../README.md)
   108