All URIs are relative to https://api.mux.com
Method | HTTP request | Description |
---|---|---|
ListDimensionValues | Get /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension |
ListDimensions | Get /data/v1/dimensions | List Dimensions |
ListDimensionValuesResponse ListDimensionValues(ctx, dIMENSIONID, optional) Lists the values for a specific dimension
Lists the values for a dimension along with a total count of related views. Note: This API replaces the list-filter-values API call.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dIMENSIONID | string | ID of the Dimension | |
optional | *ListDimensionValuesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListDimensionValuesOpts struct
Name | Type | Description | Notes |
---|
limit | optional.Int32| Number of items to include in the response | [default to 25] page | optional.Int32| Offset by this many pages, of the size of `limit` | [default to 1] filters | optional.Interface of []string| Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` | metricFilters | optional.Interface of []string| Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | timeframe | optional.Interface of []string| 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` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListDimensionsResponse ListDimensions(ctx, ) List Dimensions
List all available dimensions. Note: This API replaces the list-filters API call.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]