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

     1  # AlertsApi
     2  
     3  All URIs are relative to *https://monitor.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchAlert**](AlertsApi.md#FetchAlert) | **Get** /v1/Alerts/{Sid} | 
     8  [**ListAlert**](AlertsApi.md#ListAlert) | **Get** /v1/Alerts | 
     9  
    10  
    11  
    12  ## FetchAlert
    13  
    14  > MonitorV1AlertInstance FetchAlert(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 Alert resource to fetch.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchAlertParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**MonitorV1AlertInstance**](MonitorV1AlertInstance.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  ## ListAlert
    55  
    56  > []MonitorV1Alert ListAlert(ctx, optional)
    57  
    58  
    59  
    60  
    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 ListAlertParams struct
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **LogLevel** | **string** | Only show alerts for this log-level.  Can be: `error`, `warning`, `notice`, or `debug`.
    74  **StartDate** | **time.Time** | Only include alerts that occurred on or after this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
    75  **EndDate** | **time.Time** | Only include alerts that occurred on or before this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
    76  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    77  **Limit** | **int** | Max number of records to return.
    78  
    79  ### Return type
    80  
    81  [**[]MonitorV1Alert**](MonitorV1Alert.md)
    82  
    83  ### Authorization
    84  
    85  [accountSid_authToken](../README.md#accountSid_authToken)
    86  
    87  ### HTTP request headers
    88  
    89  - **Content-Type**: Not defined
    90  - **Accept**: application/json
    91  
    92  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    93  [[Back to Model list]](../README.md#documentation-for-models)
    94  [[Back to README]](../README.md)
    95