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

     1  # \FiltersApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListFilterValues**](FiltersApi.md#ListFilterValues) | **Get** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter
     8  [**ListFilters**](FiltersApi.md#ListFilters) | **Get** /data/v1/filters | List Filters
     9  
    10  
    11  # **ListFilterValues**
    12  > ListFilterValuesResponse ListFilterValues(ctx, fILTERID, optional)
    13  Lists values for a specific filter
    14  
    15  The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    22    **fILTERID** | **string**| ID of the Filter | 
    23   **optional** | ***ListFilterValuesOpts** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a pointer to a ListFilterValuesOpts struct
    27  
    28  Name | Type | Description  | Notes
    29  ------------- | ------------- | ------------- | -------------
    30  
    31   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
    32   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
    33   **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.  | 
    34   **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.  | 
    35  
    36  ### Return type
    37  
    38  [**ListFilterValuesResponse**](ListFilterValuesResponse.md)
    39  
    40  ### Authorization
    41  
    42  [accessToken](../README.md#accessToken)
    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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    50  
    51  # **ListFilters**
    52  > ListFiltersResponse ListFilters(ctx, )
    53  List Filters
    54  
    55  The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
    56  
    57  ### Required Parameters
    58  This endpoint does not need any parameter.
    59  
    60  ### Return type
    61  
    62  [**ListFiltersResponse**](ListFiltersResponse.md)
    63  
    64  ### Authorization
    65  
    66  [accessToken](../README.md#accessToken)
    67  
    68  ### HTTP request headers
    69  
    70   - **Content-Type**: Not defined
    71   - **Accept**: application/json
    72  
    73  [[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)
    74