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

     1  # \DeliveryUsageApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListDeliveryUsage**](DeliveryUsageApi.md#ListDeliveryUsage) | **Get** /video/v1/delivery-usage | List Usage
     8  
     9  
    10  # **ListDeliveryUsage**
    11  > ListDeliveryUsageResponse ListDeliveryUsage(ctx, optional)
    12  List Usage
    13  
    14  Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
    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** | ***ListDeliveryUsageOpts** | optional parameters | nil if no parameters
    22  
    23  ### Optional Parameters
    24  Optional parameters are passed through a pointer to a ListDeliveryUsageOpts struct
    25  
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------
    28   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
    29   **limit** | **optional.Int32**| Number of items to include in the response | [default to 100]
    30   **assetId** | **optional.String**| Filter response to return delivery usage for this asset only. | 
    31   **timeframe** | [**optional.Interface of []string**](string.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | 
    32  
    33  ### Return type
    34  
    35  [**ListDeliveryUsageResponse**](ListDeliveryUsageResponse.md)
    36  
    37  ### Authorization
    38  
    39  [accessToken](../README.md#accessToken)
    40  
    41  ### HTTP request headers
    42  
    43   - **Content-Type**: Not defined
    44   - **Accept**: application/json
    45  
    46  [[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)
    47