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

     1  # EventsApi
     2  
     3  All URIs are relative to *https://monitor.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchEvent**](EventsApi.md#FetchEvent) | **Get** /v1/Events/{Sid} | 
     8  [**ListEvent**](EventsApi.md#ListEvent) | **Get** /v1/Events | 
     9  
    10  
    11  
    12  ## FetchEvent
    13  
    14  > MonitorV1Event FetchEvent(ctx, Sid)
    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  **Sid** | **string** | The SID of the Event resource to fetch.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchEventParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**MonitorV1Event**](MonitorV1Event.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## ListEvent
    55  
    56  > []MonitorV1Event ListEvent(ctx, optional)
    57  
    58  
    59  
    60  Returns a list of events in the account, sorted by event-date.
    61  
    62  ### Path Parameters
    63  
    64  This endpoint does not need any path parameter.
    65  
    66  ### Other Parameters
    67  
    68  Other parameters are passed through a pointer to a ListEventParams struct
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ActorSid** | **string** | Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.
    74  **EventType** | **string** | Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types).
    75  **ResourceSid** | **string** | Only include events that refer to this resource. Useful for discovering the history of a specific resource.
    76  **SourceIpAddress** | **string** | Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.
    77  **StartDate** | **time.Time** | Only include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    78  **EndDate** | **time.Time** | Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    79  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    80  **Limit** | **int** | Max number of records to return.
    81  
    82  ### Return type
    83  
    84  [**[]MonitorV1Event**](MonitorV1Event.md)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: application/json
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98