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

     1  # \VideoViewsApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetVideoView**](VideoViewsApi.md#GetVideoView) | **Get** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View
     8  [**ListVideoViews**](VideoViewsApi.md#ListVideoViews) | **Get** /data/v1/video-views | List Video Views
     9  
    10  
    11  # **GetVideoView**
    12  > VideoViewResponse GetVideoView(ctx, vIDEOVIEWID)
    13  Get a Video View
    14  
    15  Returns the details of a video view.
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    22    **vIDEOVIEWID** | **string**| ID of the Video View | 
    23  
    24  ### Return type
    25  
    26  [**VideoViewResponse**](VideoViewResponse.md)
    27  
    28  ### Authorization
    29  
    30  [accessToken](../README.md#accessToken)
    31  
    32  ### HTTP request headers
    33  
    34   - **Content-Type**: Not defined
    35   - **Accept**: application/json
    36  
    37  [[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)
    38  
    39  # **ListVideoViews**
    40  > ListVideoViewsResponse ListVideoViews(ctx, optional)
    41  List Video Views
    42  
    43  Returns a list of video views.
    44  
    45  ### Required Parameters
    46  
    47  Name | Type | Description  | Notes
    48  ------------- | ------------- | ------------- | -------------
    49   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    50   **optional** | ***ListVideoViewsOpts** | optional parameters | nil if no parameters
    51  
    52  ### Optional Parameters
    53  Optional parameters are passed through a pointer to a ListVideoViewsOpts struct
    54  
    55  Name | Type | Description  | Notes
    56  ------------- | ------------- | ------------- | -------------
    57   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
    58   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
    59   **viewerId** | **optional.String**| Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux. | 
    60   **errorId** | **optional.Int32**| Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | 
    61   **orderDirection** | **optional.String**| Sort order. | 
    62   **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.  | 
    63   **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.  | 
    64  
    65  ### Return type
    66  
    67  [**ListVideoViewsResponse**](ListVideoViewsResponse.md)
    68  
    69  ### Authorization
    70  
    71  [accessToken](../README.md#accessToken)
    72  
    73  ### HTTP request headers
    74  
    75   - **Content-Type**: Not defined
    76   - **Accept**: application/json
    77  
    78  [[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)
    79