Class: PureCloud::AnalyticsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/analytics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalyticsApi

Returns a new instance of AnalyticsApi.



7
8
9
 
# File 'lib/purecloud/api/analytics_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/analytics_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#create_alerting_rules(opts = {}) ⇒ Rule

Create an alerting rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Rule) —

    Rule

Returns:



392
393
394
395
 
# File 'lib/purecloud/api/analytics_api.rb', line 392

def create_alerting_rules(opts = {})
  data, status_code, headers = create_alerting_rules_with_http_info(opts)
  return data
end

#create_alerting_rules_with_http_info(opts = {}) ⇒ Array<(Rule, Fixnum, Hash)>

Create an alerting rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Rule) —

    Rule

Returns:

  • (Array<(Rule, Fixnum, Hash)>) —

    Rule data, response status code and response headers



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
 
# File 'lib/purecloud/api/analytics_api.rb', line 402

def create_alerting_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#create_alerting_rules ..."
  end
  
  # resource path
  path = "/api/v1/analytics/alerting/rules".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Rule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#create_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_metrics_query(opts = {}) ⇒ nil

Executes a metrics query against the analytics service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body) —

    queryObject

Returns:

  • (nil) 


634
635
636
637
 
# File 'lib/purecloud/api/analytics_api.rb', line 634

def create_metrics_query(opts = {})
  create_metrics_query_with_http_info(opts)
  return nil
end

#create_metrics_query_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Executes a metrics query against the analytics service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body) —

    queryObject

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/purecloud/api/analytics_api.rb', line 644

def create_metrics_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#create_metrics_query ..."
  end
  
  # resource path
  path = "/api/v1/analytics/metrics/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#create_metrics_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reporting_schedule_runreport(schedule_id, opts = {}) ⇒ RunNowResponse

Place a scheduled report immediately into the reporting queue

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



1314
1315
1316
1317
 
# File 'lib/purecloud/api/analytics_api.rb', line 1314

def create_reporting_schedule_runreport(schedule_id, opts = {})
  data, status_code, headers = create_reporting_schedule_runreport_with_http_info(schedule_id, opts)
  return data
end

#create_reporting_schedule_runreport_with_http_info(schedule_id, opts = {}) ⇒ Array<(RunNowResponse, Fixnum, Hash)>

Place a scheduled report immediately into the reporting queue

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (Array<(RunNowResponse, Fixnum, Hash)>) —

    RunNowResponse data, response status code and response headers



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/purecloud/api/analytics_api.rb', line 1324

def create_reporting_schedule_runreport_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#create_reporting_schedule_runreport ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling create_reporting_schedule_runreport" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}/runreport".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RunNowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#create_reporting_schedule_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reporting_schedules(opts = {}) ⇒ ReportSchedule

Create a scheduled report job Create a scheduled report job.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



877
878
879
880
 
# File 'lib/purecloud/api/analytics_api.rb', line 877

def create_reporting_schedules(opts = {})
  data, status_code, headers = create_reporting_schedules_with_http_info(opts)
  return data
end

#create_reporting_schedules_with_http_info(opts = {}) ⇒ Array<(ReportSchedule, Fixnum, Hash)>

Create a scheduled report job Create a scheduled report job.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ReportSchedule, Fixnum, Hash)>) —

    ReportSchedule data, response status code and response headers



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/purecloud/api/analytics_api.rb', line 887

def create_reporting_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#create_reporting_schedules ..."
  end
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#create_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_segments_query(opts = {}) ⇒ nil

Executes a segments query against the analytics service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body1) —

    queryObject

Returns:

  • (nil) 


1498
1499
1500
1501
 
# File 'lib/purecloud/api/analytics_api.rb', line 1498

def create_segments_query(opts = {})
  create_segments_query_with_http_info(opts)
  return nil
end

#create_segments_query_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Executes a segments query against the analytics service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body1) —

    queryObject

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/purecloud/api/analytics_api.rb', line 1508

def create_segments_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#create_segments_query ..."
  end
  
  # resource path
  path = "/api/v1/analytics/segments/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#create_segments_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_alert(alert_id, opts = {}) ⇒ nil

Delete an alert.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


264
265
266
267
 
# File 'lib/purecloud/api/analytics_api.rb', line 264

def delete_alerting_alert(alert_id, opts = {})
  delete_alerting_alert_with_http_info(alert_id, opts)
  return nil
end

#delete_alerting_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an alert.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



274
275
276
277
278
279
280
281
282
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 274

def delete_alerting_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_alert ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling delete_alerting_alert" if alert_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_rule(rule_id, opts = {}) ⇒ nil

Delete an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


574
575
576
577
 
# File 'lib/purecloud/api/analytics_api.rb', line 574

def delete_alerting_rule(rule_id, opts = {})
  delete_alerting_rule_with_http_info(rule_id, opts)
  return nil
end

#delete_alerting_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/purecloud/api/analytics_api.rb', line 584

def delete_alerting_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_rule ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling delete_alerting_rule" if rule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_reporting_schedule(schedule_id, opts = {}) ⇒ String

Delete a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (String) 


1059
1060
1061
1062
 
# File 'lib/purecloud/api/analytics_api.rb', line 1059

def delete_reporting_schedule(schedule_id, opts = {})
  data, status_code, headers = delete_reporting_schedule_with_http_info(schedule_id, opts)
  return data
end

#delete_reporting_schedule_with_http_info(schedule_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/purecloud/api/analytics_api.rb', line 1069

def delete_reporting_schedule_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_reporting_schedule ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling delete_reporting_schedule" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#delete_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_alert(alert_id, opts = {}) ⇒ Alert

Get an alert.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/purecloud/api/analytics_api.rb', line 140

def get_alerting_alert(alert_id, opts = {})
  data, status_code, headers = get_alerting_alert_with_http_info(alert_id, opts)
  return data
end

#get_alerting_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(Alert, Fixnum, Hash)>

Get an alert.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (Array<(Alert, Fixnum, Hash)>) —

    Alert data, response status code and response headers



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
 
# File 'lib/purecloud/api/analytics_api.rb', line 150

def get_alerting_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alert ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling get_alerting_alert" if alert_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Alert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_alerts(opts = {}) ⇒ AlertEntityListing

Get a list of alerts.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    title, startTime, endTime, description or unread

  • :sort_order (String) —

    ascending or descending

Returns:



19
20
21
22
 
# File 'lib/purecloud/api/analytics_api.rb', line 19

def get_alerting_alerts(opts = {})
  data, status_code, headers = get_alerting_alerts_with_http_info(opts)
  return data
end

#get_alerting_alerts_unread(opts = {}) ⇒ UnreadMetric

A count of unread alerts.

Parameters:

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/purecloud/api/analytics_api.rb', line 83

def get_alerting_alerts_unread(opts = {})
  data, status_code, headers = get_alerting_alerts_unread_with_http_info(opts)
  return data
end

#get_alerting_alerts_unread_with_http_info(opts = {}) ⇒ Array<(UnreadMetric, Fixnum, Hash)>

A count of unread alerts.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(UnreadMetric, Fixnum, Hash)>) —

    UnreadMetric data, response status code and response headers



92
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
132
133
 
# File 'lib/purecloud/api/analytics_api.rb', line 92

def get_alerting_alerts_unread_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_unread ..."
  end
  
  # resource path
  path = "/api/v1/analytics/alerting/alerts/unread".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnreadMetric')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_alerts_with_http_info(opts = {}) ⇒ Array<(AlertEntityListing, Fixnum, Hash)>

Get a list of alerts.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    title, startTime, endTime, description or unread

  • :sort_order (String) —

    ascending or descending

Returns:

  • (Array<(AlertEntityListing, Fixnum, Hash)>) —

    AlertEntityListing data, response status code and response headers



32
33
34
35
36
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 32

def get_alerting_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts ..."
  end
  
  # resource path
  path = "/api/v1/analytics/alerting/alerts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AlertEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_rule(rule_id, opts = {}) ⇒ Rule

Get an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:



450
451
452
453
 
# File 'lib/purecloud/api/analytics_api.rb', line 450

def get_alerting_rule(rule_id, opts = {})
  data, status_code, headers = get_alerting_rule_with_http_info(rule_id, opts)
  return data
end

#get_alerting_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(Rule, Fixnum, Hash)>

Get an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (Array<(Rule, Fixnum, Hash)>) —

    Rule data, response status code and response headers



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/purecloud/api/analytics_api.rb', line 460

def get_alerting_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rule ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling get_alerting_rule" if rule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Rule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_rules(opts = {}) ⇒ RuleEntityListing

Get a list of rules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    title, description, inAlarm or enabled

  • :sort_order (String) —

    ascending or descending

Returns:



327
328
329
330
 
# File 'lib/purecloud/api/analytics_api.rb', line 327

def get_alerting_rules(opts = {})
  data, status_code, headers = get_alerting_rules_with_http_info(opts)
  return data
end

#get_alerting_rules_with_http_info(opts = {}) ⇒ Array<(RuleEntityListing, Fixnum, Hash)>

Get a list of rules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    title, description, inAlarm or enabled

  • :sort_order (String) —

    ascending or descending

Returns:

  • (Array<(RuleEntityListing, Fixnum, Hash)>) —

    RuleEntityListing data, response status code and response headers



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
378
379
380
381
382
383
384
385
 
# File 'lib/purecloud/api/analytics_api.rb', line 340

def get_alerting_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules ..."
  end
  
  # resource path
  path = "/api/v1/analytics/alerting/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_metadata(opts = {}) ⇒ ReportMetaDataEntityListing

Get list of reporting metadata.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :accept_language (String) —

    Accepted language

  • :locale (String) —

    Locale

Returns:



694
695
696
697
 
# File 'lib/purecloud/api/analytics_api.rb', line 694

def get_reporting_metadata(opts = {})
  data, status_code, headers = get_reporting_metadata_with_http_info(opts)
  return data
end

#get_reporting_metadata_with_http_info(opts = {}) ⇒ Array<(ReportMetaDataEntityListing, Fixnum, Hash)>

Get list of reporting metadata.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :accept_language (String) —

    Accepted language

  • :locale (String) —

    Locale

Returns:



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/purecloud/api/analytics_api.rb', line 707

def get_reporting_metadata_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_metadata ..."
  end
  
  # resource path
  path = "/api/v1/analytics/reporting/metadata".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'locale'] = opts[:'locale'] if opts[:'locale']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportMetaDataEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_report_metadata(report_id, opts = {}) ⇒ ReportMetaData

Get a reporting metadata.

Parameters:

  • report_id —

    Report ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Accepted language

  • :locale (String) —

    Locale

Returns:



1433
1434
1435
1436
 
# File 'lib/purecloud/api/analytics_api.rb', line 1433

def get_reporting_report_metadata(report_id, opts = {})
  data, status_code, headers = get_reporting_report_metadata_with_http_info(report_id, opts)
  return data
end

#get_reporting_report_metadata_with_http_info(report_id, opts = {}) ⇒ Array<(ReportMetaData, Fixnum, Hash)>

Get a reporting metadata.

Parameters:

  • report_id —

    Report ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Accepted language

  • :locale (String) —

    Locale

Returns:

  • (Array<(ReportMetaData, Fixnum, Hash)>) —

    ReportMetaData data, response status code and response headers



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/purecloud/api/analytics_api.rb', line 1445

def get_reporting_report_metadata_with_http_info(report_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_report_metadata ..."
  end
  
  # verify the required parameter 'report_id' is set
  fail "Missing the required parameter 'report_id' when calling get_reporting_report_metadata" if report_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/{reportId}/metadata".sub('{format}','json').sub('{' + 'reportId' + '}', report_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'locale'] = opts[:'locale'] if opts[:'locale']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportMetaData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_report_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_reportformats(opts = {}) ⇒ Array<String>

Get a list of report formats Get a list of report formats.

Parameters:

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

    the optional parameters

Returns:

  • (Array<String>) 


758
759
760
761
 
# File 'lib/purecloud/api/analytics_api.rb', line 758

def get_reporting_reportformats(opts = {})
  data, status_code, headers = get_reporting_reportformats_with_http_info(opts)
  return data
end

#get_reporting_reportformats_with_http_info(opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Get a list of report formats Get a list of report formats.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<String>, Fixnum, Hash)>) —

    Array<String> data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/purecloud/api/analytics_api.rb', line 767

def get_reporting_reportformats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_reportformats ..."
  end
  
  # resource path
  path = "/api/v1/analytics/reporting/reportformats".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_reportformats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedule(schedule_id, opts = {}) ⇒ ReportSchedule

Get a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



935
936
937
938
 
# File 'lib/purecloud/api/analytics_api.rb', line 935

def get_reporting_schedule(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedule_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedule_history(schedule_id, opts = {}) ⇒ ReportRunEntryEntityDomainListing

Get list of completed scheduled report jobs.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



1122
1123
1124
1125
 
# File 'lib/purecloud/api/analytics_api.rb', line 1122

def get_reporting_schedule_history(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedule_history_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedule_history_by_run_id(run_id, schedule_id, opts = {}) ⇒ ReportRunEntry

A completed scheduled report job A completed scheduled report job.

Parameters:

  • run_id —

    Run ID

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



1249
1250
1251
1252
 
# File 'lib/purecloud/api/analytics_api.rb', line 1249

def get_reporting_schedule_history_by_run_id(run_id, schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedule_history_by_run_id_with_http_info(run_id, schedule_id, opts)
  return data
end

#get_reporting_schedule_history_by_run_id_with_http_info(run_id, schedule_id, opts = {}) ⇒ Array<(ReportRunEntry, Fixnum, Hash)>

A completed scheduled report job A completed scheduled report job.

Parameters:

  • run_id —

    Run ID

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (Array<(ReportRunEntry, Fixnum, Hash)>) —

    ReportRunEntry data, response status code and response headers



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/purecloud/api/analytics_api.rb', line 1260

def get_reporting_schedule_history_by_run_id_with_http_info(run_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_by_run_id ..."
  end
  
  # verify the required parameter 'run_id' is set
  fail "Missing the required parameter 'run_id' when calling get_reporting_schedule_history_by_run_id" if run_id.nil?
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_by_run_id" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/{runId}".sub('{format}','json').sub('{' + 'runId' + '}', run_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportRunEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_by_run_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedule_history_latest(schedule_id, opts = {}) ⇒ ReportRunEntry

Get most recently completed scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



1187
1188
1189
1190
 
# File 'lib/purecloud/api/analytics_api.rb', line 1187

def get_reporting_schedule_history_latest(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedule_history_latest_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {}) ⇒ Array<(ReportRunEntry, Fixnum, Hash)>

Get most recently completed scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (Array<(ReportRunEntry, Fixnum, Hash)>) —

    ReportRunEntry data, response status code and response headers



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/purecloud/api/analytics_api.rb', line 1197

def get_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_latest ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_latest" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/latest".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportRunEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedule_history_with_http_info(schedule_id, opts = {}) ⇒ Array<(ReportRunEntryEntityDomainListing, Fixnum, Hash)>

Get list of completed scheduled report jobs.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/purecloud/api/analytics_api.rb', line 1134

def get_reporting_schedule_history_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportRunEntryEntityDomainListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedule_with_http_info(schedule_id, opts = {}) ⇒ Array<(ReportSchedule, Fixnum, Hash)>

Get a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (Array<(ReportSchedule, Fixnum, Hash)>) —

    ReportSchedule data, response status code and response headers



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'lib/purecloud/api/analytics_api.rb', line 945

def get_reporting_schedule_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedules(opts = {}) ⇒ ReportScheduleEntityListing

Get a list of scheduled report jobs Get a list of scheduled report jobs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



816
817
818
819
 
# File 'lib/purecloud/api/analytics_api.rb', line 816

def get_reporting_schedules(opts = {})
  data, status_code, headers = get_reporting_schedules_with_http_info(opts)
  return data
end

#get_reporting_schedules_with_http_info(opts = {}) ⇒ Array<(ReportScheduleEntityListing, Fixnum, Hash)>

Get a list of scheduled report jobs Get a list of scheduled report jobs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/purecloud/api/analytics_api.rb', line 827

def get_reporting_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules ..."
  end
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportScheduleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_timeperiods(opts = {}) ⇒ Array<String>

Get a list of report time periods.

Parameters:

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

    the optional parameters

Returns:

  • (Array<String>) 


1374
1375
1376
1377
 
# File 'lib/purecloud/api/analytics_api.rb', line 1374

def get_reporting_timeperiods(opts = {})
  data, status_code, headers = get_reporting_timeperiods_with_http_info(opts)
  return data
end

#get_reporting_timeperiods_with_http_info(opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Get a list of report time periods.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<String>, Fixnum, Hash)>) —

    Array<String> data, response status code and response headers



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
 
# File 'lib/purecloud/api/analytics_api.rb', line 1383

def get_reporting_timeperiods_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_timeperiods ..."
  end
  
  # resource path
  path = "/api/v1/analytics/reporting/timeperiods".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_timeperiods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_alerting_alert(alert_id, opts = {}) ⇒ Alert

Update an alerts unread status.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :body (Alert) —

    Alert

Returns:



202
203
204
205
 
# File 'lib/purecloud/api/analytics_api.rb', line 202

def update_alerting_alert(alert_id, opts = {})
  data, status_code, headers = update_alerting_alert_with_http_info(alert_id, opts)
  return data
end

#update_alerting_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(Alert, Fixnum, Hash)>

Update an alerts unread status.

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :body (Alert) —

    Alert

Returns:

  • (Array<(Alert, Fixnum, Hash)>) —

    Alert data, response status code and response headers



213
214
215
216
217
218
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 213

def update_alerting_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#update_alerting_alert ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling update_alerting_alert" if alert_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Alert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#update_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_alerting_rule(rule_id, opts = {}) ⇒ Rule

Update an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :body (Rule) —

    Rule

Returns:



512
513
514
515
 
# File 'lib/purecloud/api/analytics_api.rb', line 512

def update_alerting_rule(rule_id, opts = {})
  data, status_code, headers = update_alerting_rule_with_http_info(rule_id, opts)
  return data
end

#update_alerting_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(Rule, Fixnum, Hash)>

Update an alerting rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :body (Rule) —

    Rule

Returns:

  • (Array<(Rule, Fixnum, Hash)>) —

    Rule data, response status code and response headers



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/purecloud/api/analytics_api.rb', line 523

def update_alerting_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#update_alerting_rule ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling update_alerting_rule" if rule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Rule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#update_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_reporting_schedule(schedule_id, opts = {}) ⇒ ReportSchedule

Update a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

Returns:



997
998
999
1000
 
# File 'lib/purecloud/api/analytics_api.rb', line 997

def update_reporting_schedule(schedule_id, opts = {})
  data, status_code, headers = update_reporting_schedule_with_http_info(schedule_id, opts)
  return data
end

#update_reporting_schedule_with_http_info(schedule_id, opts = {}) ⇒ Array<(ReportSchedule, Fixnum, Hash)>

Update a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ReportSchedule, Fixnum, Hash)>) —

    ReportSchedule data, response status code and response headers



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/purecloud/api/analytics_api.rb', line 1008

def update_reporting_schedule_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#update_reporting_schedule ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling update_reporting_schedule" if schedule_id.nil?
  
  # resource path
  path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#update_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end