github.com/muxinc/mux-go@v1.1.1/docs/ErrorsApi.md (about)

     1  # \ErrorsApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListErrors**](ErrorsApi.md#ListErrors) | **Get** /data/v1/errors | List Errors
     8  
     9  
    10  # **ListErrors**
    11  > ListErrorsResponse ListErrors(ctx, optional)
    12  List Errors
    13  
    14  Returns a list of errors.
    15  
    16  ### Required Parameters
    17  
    18  Name | Type | Description  | Notes
    19  ------------- | ------------- | ------------- | -------------
    20   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    21   **optional** | ***ListErrorsOpts** | optional parameters | nil if no parameters
    22  
    23  ### Optional Parameters
    24  Optional parameters are passed through a pointer to a ListErrorsOpts struct
    25  
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------
    28   **filters** | [**optional.Interface of []string**](string.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.  | 
    29   **timeframe** | [**optional.Interface of []string**](string.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600   * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.  | 
    30  
    31  ### Return type
    32  
    33  [**ListErrorsResponse**](ListErrorsResponse.md)
    34  
    35  ### Authorization
    36  
    37  [accessToken](../README.md#accessToken)
    38  
    39  ### HTTP request headers
    40  
    41   - **Content-Type**: Not defined
    42   - **Accept**: application/json
    43  
    44  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    45