# MuxRuby::MetricsApi All URIs are relative to *https://api.mux.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**get_metric_timeseries_data**](MetricsApi.md#get_metric_timeseries_data) | **GET** /data/v1/metrics/{METRIC_ID}/timeseries | Get metric timeseries data | | [**get_overall_values**](MetricsApi.md#get_overall_values) | **GET** /data/v1/metrics/{METRIC_ID}/overall | Get Overall values | | [**list_all_metric_values**](MetricsApi.md#list_all_metric_values) | **GET** /data/v1/metrics/comparison | List all metric values | | [**list_breakdown_values**](MetricsApi.md#list_breakdown_values) | **GET** /data/v1/metrics/{METRIC_ID}/breakdown | List breakdown values | | [**list_insights**](MetricsApi.md#list_insights) | **GET** /data/v1/metrics/{METRIC_ID}/insights | List Insights | ## get_metric_timeseries_data > get_metric_timeseries_data(metric_id, opts) Get metric timeseries data Returns timeseries data for a specific metric. ### Examples ```ruby require 'time' require 'mux_ruby' # setup authorization MuxRuby.configure do |config| # Configure HTTP basic authorization: accessToken config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MuxRuby::MetricsApi.new metric_id = 'aggregate_startup_time' # String | ID of the Metric opts = { timeframe: ['inner_example'], # Array | 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` filters: ['inner_example'], # Array | 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` measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. order_direction: 'asc', # String | Sort order. group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. } begin # Get metric timeseries data result = api_instance.get_metric_timeseries_data(metric_id, opts) p result rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->get_metric_timeseries_data: #{e}" end ``` #### Using the get_metric_timeseries_data_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_metric_timeseries_data_with_http_info(metric_id, opts) ```ruby begin # Get metric timeseries data data, status_code, headers = api_instance.get_metric_timeseries_data_with_http_info(metric_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->get_metric_timeseries_data_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **metric_id** | **String** | ID of the Metric | | | **timeframe** | [**Array<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` | [optional] | | **filters** | [**Array<String>**](String.md) | 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` | [optional] | | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] | | **order_direction** | **String** | Sort order. | [optional] | | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] | ### Return type [**GetMetricTimeseriesDataResponse**](GetMetricTimeseriesDataResponse.md) ### Authorization [accessToken](../README.md#accessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_overall_values > get_overall_values(metric_id, opts) Get Overall values Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric. ### Examples ```ruby require 'time' require 'mux_ruby' # setup authorization MuxRuby.configure do |config| # Configure HTTP basic authorization: accessToken config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MuxRuby::MetricsApi.new metric_id = 'aggregate_startup_time' # String | ID of the Metric opts = { timeframe: ['inner_example'], # Array | 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` filters: ['inner_example'], # Array | 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` measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used. } begin # Get Overall values result = api_instance.get_overall_values(metric_id, opts) p result rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->get_overall_values: #{e}" end ``` #### Using the get_overall_values_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_overall_values_with_http_info(metric_id, opts) ```ruby begin # Get Overall values data, status_code, headers = api_instance.get_overall_values_with_http_info(metric_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->get_overall_values_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **metric_id** | **String** | ID of the Metric | | | **timeframe** | [**Array<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` | [optional] | | **filters** | [**Array<String>**](String.md) | 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` | [optional] | | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] | ### Return type [**GetOverallValuesResponse**](GetOverallValuesResponse.md) ### Authorization [accessToken](../README.md#accessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_all_metric_values > list_all_metric_values(opts) List all metric values List all of the values across every breakdown for a specific metric. ### Examples ```ruby require 'time' require 'mux_ruby' # setup authorization MuxRuby.configure do |config| # Configure HTTP basic authorization: accessToken config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MuxRuby::MetricsApi.new opts = { timeframe: ['inner_example'], # Array | 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` filters: ['inner_example'], # Array | 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` dimension: 'asn', # String | Dimension the specified value belongs to value: 'value_example' # String | Value to show all available metrics for } begin # List all metric values result = api_instance.list_all_metric_values(opts) p result rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_all_metric_values: #{e}" end ``` #### Using the list_all_metric_values_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> list_all_metric_values_with_http_info(opts) ```ruby begin # List all metric values data, status_code, headers = api_instance.list_all_metric_values_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_all_metric_values_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **timeframe** | [**Array<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` | [optional] | | **filters** | [**Array<String>**](String.md) | 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` | [optional] | | **dimension** | **String** | Dimension the specified value belongs to | [optional] | | **value** | **String** | Value to show all available metrics for | [optional] | ### Return type [**ListAllMetricValuesResponse**](ListAllMetricValuesResponse.md) ### Authorization [accessToken](../README.md#accessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_breakdown_values > list_breakdown_values(metric_id, opts) List breakdown values List the breakdown values for a specific metric. ### Examples ```ruby require 'time' require 'mux_ruby' # setup authorization MuxRuby.configure do |config| # Configure HTTP basic authorization: accessToken config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MuxRuby::MetricsApi.new metric_id = 'aggregate_startup_time' # String | ID of the Metric opts = { group_by: 'asn', # String | Breakdown value to group the results by measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. filters: ['inner_example'], # Array | 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` limit: 56, # Integer | Number of items to include in the response page: 56, # Integer | Offset by this many pages, of the size of `limit` order_by: 'negative_impact', # String | Value to order the results by order_direction: 'asc', # String | Sort order. timeframe: ['inner_example'] # Array | 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` } begin # List breakdown values result = api_instance.list_breakdown_values(metric_id, opts) p result rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_breakdown_values: #{e}" end ``` #### Using the list_breakdown_values_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> list_breakdown_values_with_http_info(metric_id, opts) ```ruby begin # List breakdown values data, status_code, headers = api_instance.list_breakdown_values_with_http_info(metric_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_breakdown_values_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **metric_id** | **String** | ID of the Metric | | | **group_by** | **String** | Breakdown value to group the results by | [optional] | | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] | | **filters** | [**Array<String>**](String.md) | 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` | [optional] | | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] | | **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] | | **order_by** | **String** | Value to order the results by | [optional] | | **order_direction** | **String** | Sort order. | [optional] | | **timeframe** | [**Array<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` | [optional] | ### Return type [**ListBreakdownValuesResponse**](ListBreakdownValuesResponse.md) ### Authorization [accessToken](../README.md#accessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_insights > list_insights(metric_id, opts) List Insights Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric. ### Examples ```ruby require 'time' require 'mux_ruby' # setup authorization MuxRuby.configure do |config| # Configure HTTP basic authorization: accessToken config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MuxRuby::MetricsApi.new metric_id = 'aggregate_startup_time' # String | ID of the Metric opts = { measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. order_direction: 'asc', # String | Sort order. timeframe: ['inner_example'] # Array | 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` } begin # List Insights result = api_instance.list_insights(metric_id, opts) p result rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_insights: #{e}" end ``` #### Using the list_insights_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> list_insights_with_http_info(metric_id, opts) ```ruby begin # List Insights data, status_code, headers = api_instance.list_insights_with_http_info(metric_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue MuxRuby::ApiError => e puts "Error when calling MetricsApi->list_insights_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **metric_id** | **String** | ID of the Metric | | | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] | | **order_direction** | **String** | Sort order. | [optional] | | **timeframe** | [**Array<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` | [optional] | ### Return type [**ListInsightsResponse**](ListInsightsResponse.md) ### Authorization [accessToken](../README.md#accessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json