Class: MuxRuby::MetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetricsApi

Returns a new instance of MetricsApi.



19
20
21
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_metric_timeseries_data(metric_id, opts = {}) ⇒ GetMetricTimeseriesDataResponse

Get metric timeseries data Returns timeseries data for a specific metric.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :order_direction (String) —

    Sort order.

  • :group_by (String) —

    Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.

Returns:



32
33
34
35
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 32

def get_metric_timeseries_data(metric_id, opts = {})
  data, _status_code, _headers = get_metric_timeseries_data_with_http_info(metric_id, opts)
  data
end

#get_metric_timeseries_data_with_http_info(metric_id, opts = {}) ⇒ Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>

Get metric timeseries data Returns timeseries data for a specific metric.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :order_direction (String) —

    Sort order.

  • :group_by (String) —

    Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 47

def get_metric_timeseries_data_with_http_info(metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.get_metric_timeseries_data ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
  end
  # verify enum value
  allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
    fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["95th", "median", "avg", "count", "sum"]
  if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
    fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  allowable_values = ["hour", "day"]
  if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
    fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/metrics/{METRIC_ID}/timeseries'.sub('{' + 'METRIC_ID' + '}', CGI.escape(metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMetricTimeseriesDataResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MetricsApi.get_metric_timeseries_data",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#get_metric_timeseries_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_overall_values(metric_id, opts = {}) ⇒ GetOverallValuesResponse

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.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

Returns:



125
126
127
128
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 125

def get_overall_values(metric_id, opts = {})
  data, _status_code, _headers = get_overall_values_with_http_info(metric_id, opts)
  data
end

#get_overall_values_with_http_info(metric_id, opts = {}) ⇒ Array<(GetOverallValuesResponse, Integer, Hash)>

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.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

Returns:

  • (Array<(GetOverallValuesResponse, Integer, Hash)>) —

    GetOverallValuesResponse data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 138

def get_overall_values_with_http_info(metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.get_overall_values ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
  end
  # verify enum value
  allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
    fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["95th", "median", "avg", "count", "sum"]
  if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
    fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/metrics/{METRIC_ID}/overall'.sub('{' + 'METRIC_ID' + '}', CGI.escape(metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetOverallValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MetricsApi.get_overall_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#get_overall_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_all_metric_values(opts = {}) ⇒ ListAllMetricValuesResponse

List all metric values List all of the values across every breakdown for a specific metric.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :dimension (String) —

    Dimension the specified value belongs to

  • :value (String) —

    Value to show all available metrics for

Returns:



206
207
208
209
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 206

def list_all_metric_values(opts = {})
  data, _status_code, _headers = list_all_metric_values_with_http_info(opts)
  data
end

#list_all_metric_values_with_http_info(opts = {}) ⇒ Array<(ListAllMetricValuesResponse, Integer, Hash)>

List all metric values List all of the values across every breakdown for a specific metric.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :dimension (String) —

    Dimension the specified value belongs to

  • :value (String) —

    Value to show all available metrics for

Returns:

  • (Array<(ListAllMetricValuesResponse, Integer, Hash)>) —

    ListAllMetricValuesResponse data, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 219

def list_all_metric_values_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
  end
  allowable_values = ["asn", "browser", "browser_version", "cdn", "continent_code", "country", "exit_before_video_start", "experiment_name", "operating_system", "operating_system_version", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_title", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
  if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
    fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/metrics/comparison'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListAllMetricValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MetricsApi.list_all_metric_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_all_metric_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_breakdown_values(metric_id, opts = {}) ⇒ ListBreakdownValuesResponse

List breakdown values List the breakdown values for a specific metric.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_by (String) —

    Breakdown value to group the results by

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :limit (Integer) —

    Number of items to include in the response (default to 25)

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

Returns:



284
285
286
287
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 284

def list_breakdown_values(metric_id, opts = {})
  data, _status_code, _headers = list_breakdown_values_with_http_info(metric_id, opts)
  data
end

#list_breakdown_values_with_http_info(metric_id, opts = {}) ⇒ Array<(ListBreakdownValuesResponse, Integer, Hash)>

List breakdown values List the breakdown values for a specific metric.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_by (String) —

    Breakdown value to group the results by

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :filters (Array<String>) —

    Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

Returns:

  • (Array<(ListBreakdownValuesResponse, Integer, Hash)>) —

    ListBreakdownValuesResponse data, response status code and response headers



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 302

def list_breakdown_values_with_http_info(metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_breakdown_values ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
  end
  # verify enum value
  allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
    fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["asn", "browser", "browser_version", "cdn", "continent_code", "country", "exit_before_video_start", "experiment_name", "operating_system", "operating_system_version", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_title", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
  if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
    fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
  end
  allowable_values = ["95th", "median", "avg", "count", "sum"]
  if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
    fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
  end
  allowable_values = ["negative_impact", "value", "views", "field"]
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
    fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/metrics/{METRIC_ID}/breakdown'.sub('{' + 'METRIC_ID' + '}', CGI.escape(metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListBreakdownValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MetricsApi.list_breakdown_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_breakdown_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_insights(metric_id, opts = {}) ⇒ ListInsightsResponse

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.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :order_direction (String) —

    Sort order.

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

Returns:



387
388
389
390
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 387

def list_insights(metric_id, opts = {})
  data, _status_code, _headers = list_insights_with_http_info(metric_id, opts)
  data
end

#list_insights_with_http_info(metric_id, opts = {}) ⇒ Array<(ListInsightsResponse, Integer, Hash)>

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.

Parameters:

  • metric_id (String) —

    ID of the Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :measurement (String) —

    Measurement for the provided metric. If omitted, the default for the metric will be used.

  • :order_direction (String) —

    Sort order.

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are… * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.

Returns:

  • (Array<(ListInsightsResponse, Integer, Hash)>) —

    ListInsightsResponse data, response status code and response headers



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/mux_ruby/api/metrics_api.rb', line 400

def list_insights_with_http_info(metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_insights ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
  end
  # verify enum value
  allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
    fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["95th", "median", "avg", "count", "sum"]
  if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
    fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/metrics/{METRIC_ID}/insights'.sub('{' + 'METRIC_ID' + '}', CGI.escape(metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MetricsApi.list_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end