Class: LaunchDarklyApi::CustomerMetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/customer_metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomerMetricsApi

Returns a new instance of CustomerMetricsApi.



19
20
21
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_evaluations(env_id, flag_key, opts = {}) ⇒ StreamSDKVersion

Get events usage by event id and the feature flag key.

Parameters:

  • env_id

    The environment id for the flag evaluations in question.

  • flag_key

    The key of the flag we want metrics for.

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

    the optional parameters

Returns:



27
28
29
30
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 27

def get_evaluations(env_id, flag_key, opts = {})
  data, _status_code, _headers = get_evaluations_with_http_info(env_id, flag_key, opts)
  data
end

#get_evaluations_with_http_info(env_id, flag_key, opts = {}) ⇒ Array<(StreamSDKVersion, Fixnum, Hash)>

Get events usage by event id and the feature flag key.

Parameters:

  • env_id

    The environment id for the flag evaluations in question.

  • flag_key

    The key of the flag we want metrics for.

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

    the optional parameters

Returns:

  • (Array<(StreamSDKVersion, Fixnum, Hash)>)

    StreamSDKVersion data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
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
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 37

def get_evaluations_with_http_info(env_id, flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_evaluations ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling CustomerMetricsApi.get_evaluations"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling CustomerMetricsApi.get_evaluations"
  end
  # resource path
  local_var_path = '/usage/evaluations/{envId}/{flagKey}'.sub('{' + 'envId' + '}', env_id.to_s).sub('{' + 'flagKey' + '}', flag_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StreamSDKVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_event(type, opts = {}) ⇒ StreamSDKVersion

Get events usage by event type.

Parameters:

  • type

    The type of event we would like to track.

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

    the optional parameters

Returns:



84
85
86
87
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 84

def get_event(type, opts = {})
  data, _status_code, _headers = get_event_with_http_info(type, opts)
  data
end

#get_event_with_http_info(type, opts = {}) ⇒ Array<(StreamSDKVersion, Fixnum, Hash)>

Get events usage by event type.

Parameters:

  • type

    The type of event we would like to track.

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

    the optional parameters

Returns:

  • (Array<(StreamSDKVersion, Fixnum, Hash)>)

    StreamSDKVersion data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 93

def get_event_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_event ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CustomerMetricsApi.get_event"
  end
  # resource path
  local_var_path = '/usage/events/{type}'.sub('{' + 'type' + '}', type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StreamSDKVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_events(opts = {}) ⇒ Events

Get events usage endpoints.

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 135

def get_events(opts = {})
  data, _status_code, _headers = get_events_with_http_info(opts)
  data
end

#get_events_with_http_info(opts = {}) ⇒ Array<(Events, Fixnum, Hash)>

Get events usage endpoints.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Events, Fixnum, Hash)>)

    Events data, response status code and response headers



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
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 143

def get_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_events ...'
  end
  # resource path
  local_var_path = '/usage/events'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Events')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau(opts = {}) ⇒ MAU

Get monthly active user data.

Parameters:

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

    the optional parameters

Returns:



181
182
183
184
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 181

def get_mau(opts = {})
  data, _status_code, _headers = get_mau_with_http_info(opts)
  data
end

#get_mau_by_category(opts = {}) ⇒ MAUbyCategory

Get monthly active user data by category.

Parameters:

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

    the optional parameters

Returns:



227
228
229
230
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 227

def get_mau_by_category(opts = {})
  data, _status_code, _headers = get_mau_by_category_with_http_info(opts)
  data
end

#get_mau_by_category_with_http_info(opts = {}) ⇒ Array<(MAUbyCategory, Fixnum, Hash)>

Get monthly active user data by category.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(MAUbyCategory, Fixnum, Hash)>)

    MAUbyCategory data, response status code and response headers



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/launchdarkly_api/api/customer_metrics_api.rb', line 235

def get_mau_by_category_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_mau_by_category ...'
  end
  # resource path
  local_var_path = '/usage/mau/bycategory'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MAUbyCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_mau_by_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_with_http_info(opts = {}) ⇒ Array<(MAU, Fixnum, Hash)>

Get monthly active user data.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(MAU, Fixnum, Hash)>)

    MAU data, response status code and response headers



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 189

def get_mau_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_mau ...'
  end
  # resource path
  local_var_path = '/usage/mau'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MAU')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_mau\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream(source, opts = {}) ⇒ Stream

Get a stream endpoint and return timeseries data.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:



274
275
276
277
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 274

def get_stream(source, opts = {})
  data, _status_code, _headers = get_stream_with_http_info(source, opts)
  data
end

#get_stream_by_sdk(source, opts = {}) ⇒ StreamBySDK

Get a stream timeseries data by source show sdk version metadata.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:



326
327
328
329
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 326

def get_stream_by_sdk(source, opts = {})
  data, _status_code, _headers = get_stream_by_sdk_with_http_info(source, opts)
  data
end

#get_stream_by_sdk_with_http_info(source, opts = {}) ⇒ Array<(StreamBySDK, Fixnum, Hash)>

Get a stream timeseries data by source show sdk version metadata.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:

  • (Array<(StreamBySDK, Fixnum, Hash)>)

    StreamBySDK data, response status code and response headers



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
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 335

def get_stream_by_sdk_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_stream_by_sdk ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling CustomerMetricsApi.get_stream_by_sdk"
  end
  # resource path
  local_var_path = '/usage/streams/{source}/bysdkversion'.sub('{' + 'source' + '}', source.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StreamBySDK')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_stream_by_sdk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream_sdk_version(source, opts = {}) ⇒ StreamSDKVersion

Get a stream timeseries data by source and show all sdk version associated.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:



378
379
380
381
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 378

def get_stream_sdk_version(source, opts = {})
  data, _status_code, _headers = get_stream_sdk_version_with_http_info(source, opts)
  data
end

#get_stream_sdk_version_with_http_info(source, opts = {}) ⇒ Array<(StreamSDKVersion, Fixnum, Hash)>

Get a stream timeseries data by source and show all sdk version associated.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:

  • (Array<(StreamSDKVersion, Fixnum, Hash)>)

    StreamSDKVersion data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
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
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 387

def get_stream_sdk_version_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_stream_sdk_version ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling CustomerMetricsApi.get_stream_sdk_version"
  end
  # resource path
  local_var_path = '/usage/streams/{source}/sdkversions'.sub('{' + 'source' + '}', source.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StreamSDKVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_stream_sdk_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream_with_http_info(source, opts = {}) ⇒ Array<(Stream, Fixnum, Hash)>

Get a stream endpoint and return timeseries data.

Parameters:

  • source

    The source of where the stream comes from.

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

    the optional parameters

Returns:

  • (Array<(Stream, Fixnum, Hash)>)

    Stream data, response status code and response headers



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 283

def get_stream_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_stream ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling CustomerMetricsApi.get_stream"
  end
  # resource path
  local_var_path = '/usage/streams/{source}'.sub('{' + 'source' + '}', source.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stream')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_streams(opts = {}) ⇒ Streams

Returns a list of all streams.

Parameters:

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

    the optional parameters

Returns:



429
430
431
432
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 429

def get_streams(opts = {})
  data, _status_code, _headers = get_streams_with_http_info(opts)
  data
end

#get_streams_with_http_info(opts = {}) ⇒ Array<(Streams, Fixnum, Hash)>

Returns a list of all streams.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Streams, Fixnum, Hash)>)

    Streams data, response status code and response headers



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
463
464
465
466
467
468
469
470
471
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 437

def get_streams_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_streams ...'
  end
  # resource path
  local_var_path = '/usage/streams'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Streams')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_streams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_usage(opts = {}) ⇒ Usage

Returns of the usage endpoints available.

Parameters:

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

    the optional parameters

Returns:



475
476
477
478
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 475

def get_usage(opts = {})
  data, _status_code, _headers = get_usage_with_http_info(opts)
  data
end

#get_usage_with_http_info(opts = {}) ⇒ Array<(Usage, Fixnum, Hash)>

Returns of the usage endpoints available.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Usage, Fixnum, Hash)>)

    Usage data, response status code and response headers



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
# File 'lib/launchdarkly_api/api/customer_metrics_api.rb', line 483

def get_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerMetricsApi.get_usage ...'
  end
  # resource path
  local_var_path = '/usage'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Usage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerMetricsApi#get_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end