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

     1  # \RealTimeApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetRealtimeBreakdown**](RealTimeApi.md#GetRealtimeBreakdown) | **Get** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown
     8  [**GetRealtimeHistogramTimeseries**](RealTimeApi.md#GetRealtimeHistogramTimeseries) | **Get** /data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries
     9  [**GetRealtimeTimeseries**](RealTimeApi.md#GetRealtimeTimeseries) | **Get** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries
    10  [**ListRealtimeDimensions**](RealTimeApi.md#ListRealtimeDimensions) | **Get** /data/v1/realtime/dimensions | List Real-Time Dimensions
    11  [**ListRealtimeMetrics**](RealTimeApi.md#ListRealtimeMetrics) | **Get** /data/v1/realtime/metrics | List Real-Time Metrics
    12  
    13  
    14  # **GetRealtimeBreakdown**
    15  > GetRealTimeBreakdownResponse GetRealtimeBreakdown(ctx, rEALTIMEMETRICID, optional)
    16  Get Real-Time Breakdown
    17  
    18  Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
    19  
    20  ### Required Parameters
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25    **rEALTIMEMETRICID** | **string**| ID of the Realtime Metric | 
    26   **optional** | ***GetRealtimeBreakdownOpts** | optional parameters | nil if no parameters
    27  
    28  ### Optional Parameters
    29  Optional parameters are passed through a pointer to a GetRealtimeBreakdownOpts struct
    30  
    31  Name | Type | Description  | Notes
    32  ------------- | ------------- | ------------- | -------------
    33  
    34   **dimension** | **optional.String**| Dimension the specified value belongs to | 
    35   **timestamp** | **optional.Float64**| Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | 
    36   **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.  | 
    37   **orderBy** | **optional.String**| Value to order the results by | 
    38   **orderDirection** | **optional.String**| Sort order. | 
    39  
    40  ### Return type
    41  
    42  [**GetRealTimeBreakdownResponse**](GetRealTimeBreakdownResponse.md)
    43  
    44  ### Authorization
    45  
    46  [accessToken](../README.md#accessToken)
    47  
    48  ### HTTP request headers
    49  
    50   - **Content-Type**: Not defined
    51   - **Accept**: application/json
    52  
    53  [[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)
    54  
    55  # **GetRealtimeHistogramTimeseries**
    56  > GetRealTimeHistogramTimeseriesResponse GetRealtimeHistogramTimeseries(ctx, rEALTIMEHISTOGRAMMETRICID, optional)
    57  Get Real-Time Histogram Timeseries
    58  
    59  Gets histogram timeseries information for a specific metric.
    60  
    61  ### Required Parameters
    62  
    63  Name | Type | Description  | Notes
    64  ------------- | ------------- | ------------- | -------------
    65   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    66    **rEALTIMEHISTOGRAMMETRICID** | **string**| ID of the Realtime Histogram Metric | 
    67   **optional** | ***GetRealtimeHistogramTimeseriesOpts** | optional parameters | nil if no parameters
    68  
    69  ### Optional Parameters
    70  Optional parameters are passed through a pointer to a GetRealtimeHistogramTimeseriesOpts struct
    71  
    72  Name | Type | Description  | Notes
    73  ------------- | ------------- | ------------- | -------------
    74  
    75   **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.  | 
    76  
    77  ### Return type
    78  
    79  [**GetRealTimeHistogramTimeseriesResponse**](GetRealTimeHistogramTimeseriesResponse.md)
    80  
    81  ### Authorization
    82  
    83  [accessToken](../README.md#accessToken)
    84  
    85  ### HTTP request headers
    86  
    87   - **Content-Type**: Not defined
    88   - **Accept**: application/json
    89  
    90  [[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)
    91  
    92  # **GetRealtimeTimeseries**
    93  > GetRealTimeTimeseriesResponse GetRealtimeTimeseries(ctx, rEALTIMEMETRICID, optional)
    94  Get Real-Time Timeseries
    95  
    96  Gets Time series information for a specific metric along with the number of concurrent viewers.
    97  
    98  ### Required Parameters
    99  
   100  Name | Type | Description  | Notes
   101  ------------- | ------------- | ------------- | -------------
   102   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   103    **rEALTIMEMETRICID** | **string**| ID of the Realtime Metric | 
   104   **optional** | ***GetRealtimeTimeseriesOpts** | optional parameters | nil if no parameters
   105  
   106  ### Optional Parameters
   107  Optional parameters are passed through a pointer to a GetRealtimeTimeseriesOpts struct
   108  
   109  Name | Type | Description  | Notes
   110  ------------- | ------------- | ------------- | -------------
   111  
   112   **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.  | 
   113  
   114  ### Return type
   115  
   116  [**GetRealTimeTimeseriesResponse**](GetRealTimeTimeseriesResponse.md)
   117  
   118  ### Authorization
   119  
   120  [accessToken](../README.md#accessToken)
   121  
   122  ### HTTP request headers
   123  
   124   - **Content-Type**: Not defined
   125   - **Accept**: application/json
   126  
   127  [[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)
   128  
   129  # **ListRealtimeDimensions**
   130  > ListRealTimeDimensionsResponse ListRealtimeDimensions(ctx, )
   131  List Real-Time Dimensions
   132  
   133  Lists available real-time dimensions.
   134  
   135  ### Required Parameters
   136  This endpoint does not need any parameter.
   137  
   138  ### Return type
   139  
   140  [**ListRealTimeDimensionsResponse**](ListRealTimeDimensionsResponse.md)
   141  
   142  ### Authorization
   143  
   144  [accessToken](../README.md#accessToken)
   145  
   146  ### HTTP request headers
   147  
   148   - **Content-Type**: Not defined
   149   - **Accept**: application/json
   150  
   151  [[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)
   152  
   153  # **ListRealtimeMetrics**
   154  > ListRealTimeMetricsResponse ListRealtimeMetrics(ctx, )
   155  List Real-Time Metrics
   156  
   157  Lists available real-time metrics.
   158  
   159  ### Required Parameters
   160  This endpoint does not need any parameter.
   161  
   162  ### Return type
   163  
   164  [**ListRealTimeMetricsResponse**](ListRealTimeMetricsResponse.md)
   165  
   166  ### Authorization
   167  
   168  [accessToken](../README.md#accessToken)
   169  
   170  ### HTTP request headers
   171  
   172   - **Content-Type**: Not defined
   173   - **Accept**: application/json
   174  
   175  [[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)
   176