|
| 1 | +# mux_python.DimensionsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.mux.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension |
| 8 | +[**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions |
| 9 | + |
| 10 | + |
| 11 | +# **list_dimension_values** |
| 12 | +> ListDimensionValuesResponse list_dimension_values(dimension_id, limit=limit, page=page, filters=filters, timeframe=timeframe) |
| 13 | +
|
| 14 | +Lists the values for a specific dimension |
| 15 | + |
| 16 | +Lists the values for a dimension along with a total count of related views. Note: This API replaces the list-filter-values API call. |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | +* Basic Authentication (accessToken): |
| 21 | +```python |
| 22 | +from __future__ import print_function |
| 23 | +import time |
| 24 | +import mux_python |
| 25 | +from mux_python.rest import ApiException |
| 26 | +from pprint import pprint |
| 27 | +configuration = mux_python.Configuration() |
| 28 | +# Configure HTTP basic authorization: accessToken |
| 29 | +configuration.username = 'YOUR_USERNAME' |
| 30 | +configuration.password = 'YOUR_PASSWORD' |
| 31 | + |
| 32 | +# create an instance of the API class |
| 33 | +api_instance = mux_python.DimensionsApi(mux_python.ApiClient(configuration)) |
| 34 | +dimension_id = abcd1234 # str | ID of the Dimension |
| 35 | +limit = 25 # int | Number of items to include in the response (optional) (default to 25) |
| 36 | +page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1) |
| 37 | +filters = ['filters_example'] # list[str] | 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. (optional) |
| 38 | +timeframe = ['timeframe_example'] # list[str] | 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. (optional) |
| 39 | + |
| 40 | +try: |
| 41 | + # Lists the values for a specific dimension |
| 42 | + api_response = api_instance.list_dimension_values(dimension_id, limit=limit, page=page, filters=filters, timeframe=timeframe) |
| 43 | + pprint(api_response) |
| 44 | +except ApiException as e: |
| 45 | + print("Exception when calling DimensionsApi->list_dimension_values: %s\n" % e) |
| 46 | +``` |
| 47 | + |
| 48 | +### Parameters |
| 49 | + |
| 50 | +Name | Type | Description | Notes |
| 51 | +------------- | ------------- | ------------- | ------------- |
| 52 | + **dimension_id** | **str**| ID of the Dimension | |
| 53 | + **limit** | **int**| Number of items to include in the response | [optional] [default to 25] |
| 54 | + **page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1] |
| 55 | + **filters** | [**list[str]**](str.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. | [optional] |
| 56 | + **timeframe** | [**list[str]**](str.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. | [optional] |
| 57 | + |
| 58 | +### Return type |
| 59 | + |
| 60 | +[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md) |
| 61 | + |
| 62 | +### Authorization |
| 63 | + |
| 64 | +[accessToken](../README.md#accessToken) |
| 65 | + |
| 66 | +### HTTP request headers |
| 67 | + |
| 68 | + - **Content-Type**: Not defined |
| 69 | + - **Accept**: application/json |
| 70 | + |
| 71 | +[[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) |
| 72 | + |
| 73 | +# **list_dimensions** |
| 74 | +> ListDimensionsResponse list_dimensions() |
| 75 | +
|
| 76 | +List Dimensions |
| 77 | + |
| 78 | +List all available dimensions. Note: This API replaces the list-filters API call. |
| 79 | + |
| 80 | +### Example |
| 81 | + |
| 82 | +* Basic Authentication (accessToken): |
| 83 | +```python |
| 84 | +from __future__ import print_function |
| 85 | +import time |
| 86 | +import mux_python |
| 87 | +from mux_python.rest import ApiException |
| 88 | +from pprint import pprint |
| 89 | +configuration = mux_python.Configuration() |
| 90 | +# Configure HTTP basic authorization: accessToken |
| 91 | +configuration.username = 'YOUR_USERNAME' |
| 92 | +configuration.password = 'YOUR_PASSWORD' |
| 93 | + |
| 94 | +# create an instance of the API class |
| 95 | +api_instance = mux_python.DimensionsApi(mux_python.ApiClient(configuration)) |
| 96 | + |
| 97 | +try: |
| 98 | + # List Dimensions |
| 99 | + api_response = api_instance.list_dimensions() |
| 100 | + pprint(api_response) |
| 101 | +except ApiException as e: |
| 102 | + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) |
| 103 | +``` |
| 104 | + |
| 105 | +### Parameters |
| 106 | +This endpoint does not need any parameter. |
| 107 | + |
| 108 | +### Return type |
| 109 | + |
| 110 | +[**ListDimensionsResponse**](ListDimensionsResponse.md) |
| 111 | + |
| 112 | +### Authorization |
| 113 | + |
| 114 | +[accessToken](../README.md#accessToken) |
| 115 | + |
| 116 | +### HTTP request headers |
| 117 | + |
| 118 | + - **Content-Type**: Not defined |
| 119 | + - **Accept**: application/json |
| 120 | + |
| 121 | +[[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) |
| 122 | + |
0 commit comments