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

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

Delete a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (String) 


737
738
739
740
 
# File 'lib/purecloud/api/analytics_api.rb', line 737

def delete_reporting_schedules_schedule_id(schedule_id, opts = {})
  data, status_code, headers = delete_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
  return data
end

#delete_reporting_schedules_schedule_id_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



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 747

def delete_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_reporting_schedules_schedule_id ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling delete_reporting_schedules_schedule_id" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_conversation_id_details(conversation_id, opts = {}) ⇒ AnalyticsConversation

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/purecloud/api/analytics_api.rb', line 132

def get_conversations_conversation_id_details(conversation_id, opts = {})
  data, status_code, headers = get_conversations_conversation_id_details_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_conversation_id_details_with_http_info(conversation_id, opts = {}) ⇒ Array<(AnalyticsConversation, Fixnum, Hash)>

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    AnalyticsConversation data, response status code and response headers



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

def get_conversations_conversation_id_details_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_conversations_conversation_id_details ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversations_conversation_id_details" if conversation_id.nil?
  
  # resource path
  path = "/api/v2/analytics/conversations/{conversationId}/details".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_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 => 'AnalyticsConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_conversations_conversation_id_details\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

  • :locale (String) —

    Locale

Returns:



374
375
376
377
 
# File 'lib/purecloud/api/analytics_api.rb', line 374

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

  • :locale (String) —

    Locale

Returns:



386
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
426
427
428
429
430
 
# File 'lib/purecloud/api/analytics_api.rb', line 386

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/v2/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)

  # 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_id_metadata(report_id, opts = {}) ⇒ ReportMetaData

Get a reporting metadata.

Parameters:

  • report_id —

    Report ID

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

    the optional parameters

Options Hash (opts):

  • :locale (String) —

    Locale

Returns:



1110
1111
1112
1113
 
# File 'lib/purecloud/api/analytics_api.rb', line 1110

def get_reporting_report_id_metadata(report_id, opts = {})
  data, status_code, headers = get_reporting_report_id_metadata_with_http_info(report_id, opts)
  return data
end

#get_reporting_report_id_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):

  • :locale (String) —

    Locale

Returns:

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

    ReportMetaData data, response status code and response headers



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 1121

def get_reporting_report_id_metadata_with_http_info(report_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_report_id_metadata ..."
  end
  
  # verify the required parameter 'report_id' is set
  fail "Missing the required parameter 'report_id' when calling get_reporting_report_id_metadata" if report_id.nil?
  
  # resource path
  path = "/api/v2/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)

  # 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_id_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>) 


436
437
438
439
 
# File 'lib/purecloud/api/analytics_api.rb', line 436

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



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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/purecloud/api/analytics_api.rb', line 445

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/v2/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_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:



494
495
496
497
 
# File 'lib/purecloud/api/analytics_api.rb', line 494

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

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

Get a scheduled report job.

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



613
614
615
616
 
# File 'lib/purecloud/api/analytics_api.rb', line 613

def get_reporting_schedules_schedule_id(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedules_schedule_id_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:



800
801
802
803
 
# File 'lib/purecloud/api/analytics_api.rb', line 800

def get_reporting_schedules_schedule_id_history(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedules_schedule_id_history_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedules_schedule_id_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:



865
866
867
868
 
# File 'lib/purecloud/api/analytics_api.rb', line 865

def get_reporting_schedules_schedule_id_history_latest(schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedules_schedule_id_history_latest_with_http_info(schedule_id, opts)
  return data
end

#get_reporting_schedules_schedule_id_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



875
876
877
878
879
880
881
882
883
884
885
886
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 875

def get_reporting_schedules_schedule_id_history_latest_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id_history_latest ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id_history_latest" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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_schedules_schedule_id_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedules_schedule_id_history_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:



927
928
929
930
 
# File 'lib/purecloud/api/analytics_api.rb', line 927

def get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id, opts = {})
  data, status_code, headers = get_reporting_schedules_schedule_id_history_run_id_with_http_info(run_id, schedule_id, opts)
  return data
end

#get_reporting_schedules_schedule_id_history_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



938
939
940
941
942
943
944
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 938

def get_reporting_schedules_schedule_id_history_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_schedules_schedule_id_history_run_id ..."
  end
  
  # verify the required parameter 'run_id' is set
  fail "Missing the required parameter 'run_id' when calling get_reporting_schedules_schedule_id_history_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_schedules_schedule_id_history_run_id" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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_schedules_schedule_id_history_run_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedules_schedule_id_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:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 812

def get_reporting_schedules_schedule_id_history_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id_history ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id_history" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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_schedules_schedule_id_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reporting_schedules_schedule_id_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



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/purecloud/api/analytics_api.rb', line 623

def get_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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:



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 505

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/v2/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>) 


1052
1053
1054
1055
 
# File 'lib/purecloud/api/analytics_api.rb', line 1052

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



1061
1062
1063
1064
1065
1066
1067
1068
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 1061

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/v2/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

#post_conversations_aggregates_query(opts = {}) ⇒ AggregateQueryResponse

Query for conversation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



16
17
18
19
 
# File 'lib/purecloud/api/analytics_api.rb', line 16

def post_conversations_aggregates_query(opts = {})
  data, status_code, headers = post_conversations_aggregates_query_with_http_info(opts)
  return data
end

#post_conversations_aggregates_query_with_http_info(opts = {}) ⇒ Array<(AggregateQueryResponse, Fixnum, Hash)>

Query for conversation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AggregateQueryResponse data, response status code and response headers



26
27
28
29
30
31
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 26

def post_conversations_aggregates_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_aggregates_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/conversations/aggregates/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,
    :return_type => 'AggregateQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_conversation_id_details_properties(conversation_id, opts = {}) ⇒ PropertyIndexRequest

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

Returns:



194
195
196
197
 
# File 'lib/purecloud/api/analytics_api.rb', line 194

def post_conversations_conversation_id_details_properties(conversation_id, opts = {})
  data, status_code, headers = post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts)
  return data
end

#post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts = {}) ⇒ Array<(PropertyIndexRequest, Fixnum, Hash)>

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PropertyIndexRequest data, response status code and response headers



205
206
207
208
209
210
211
212
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 205

def post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_conversation_id_details_properties ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversations_conversation_id_details_properties" if conversation_id.nil?
  
  # resource path
  path = "/api/v2/analytics/conversations/{conversationId}/details/properties".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_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(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PropertyIndexRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_conversation_id_details_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_details_query(opts = {}) ⇒ AnalyticsConversationQueryResponse

Query for conversation details

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



74
75
76
77
 
# File 'lib/purecloud/api/analytics_api.rb', line 74

def post_conversations_details_query(opts = {})
  data, status_code, headers = post_conversations_details_query_with_http_info(opts)
  return data
end

#post_conversations_details_query_with_http_info(opts = {}) ⇒ Array<(AnalyticsConversationQueryResponse, Fixnum, Hash)>

Query for conversation details

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloud/api/analytics_api.rb', line 84

def post_conversations_details_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_details_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/conversations/details/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,
    :return_type => 'AnalyticsConversationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_evaluations_aggregates_query(opts = {}) ⇒ AggregateQueryResponse

Query for evaluation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



256
257
258
259
 
# File 'lib/purecloud/api/analytics_api.rb', line 256

def post_evaluations_aggregates_query(opts = {})
  data, status_code, headers = post_evaluations_aggregates_query_with_http_info(opts)
  return data
end

#post_evaluations_aggregates_query_with_http_info(opts = {}) ⇒ Array<(AggregateQueryResponse, Fixnum, Hash)>

Query for evaluation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AggregateQueryResponse data, response status code and response headers



266
267
268
269
270
271
272
273
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 266

def post_evaluations_aggregates_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_evaluations_aggregates_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/evaluations/aggregates/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,
    :return_type => 'AggregateQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_queues_observations_query(opts = {}) ⇒ ObservationQueryResponse

Query for queue observations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



314
315
316
317
 
# File 'lib/purecloud/api/analytics_api.rb', line 314

def post_queues_observations_query(opts = {})
  data, status_code, headers = post_queues_observations_query_with_http_info(opts)
  return data
end

#post_queues_observations_query_with_http_info(opts = {}) ⇒ Array<(ObservationQueryResponse, Fixnum, Hash)>

Query for queue observations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ObservationQueryResponse data, response status code and response headers



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

def post_queues_observations_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_queues_observations_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/queues/observations/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,
    :return_type => 'ObservationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_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:



555
556
557
558
 
# File 'lib/purecloud/api/analytics_api.rb', line 555

def post_reporting_schedules(opts = {})
  data, status_code, headers = post_reporting_schedules_with_http_info(opts)
  return data
end

#post_reporting_schedules_schedule_id_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:



992
993
994
995
 
# File 'lib/purecloud/api/analytics_api.rb', line 992

def post_reporting_schedules_schedule_id_runreport(schedule_id, opts = {})
  data, status_code, headers = post_reporting_schedules_schedule_id_runreport_with_http_info(schedule_id, opts)
  return data
end

#post_reporting_schedules_schedule_id_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



1002
1003
1004
1005
1006
1007
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 1002

def post_reporting_schedules_schedule_id_runreport_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedules_schedule_id_runreport ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling post_reporting_schedules_schedule_id_runreport" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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#post_reporting_schedules_schedule_id_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_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



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/purecloud/api/analytics_api.rb', line 565

def post_reporting_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedules ..."
  end
  
  # resource path
  path = "/api/v2/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#post_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_users_aggregates_query(opts = {}) ⇒ PresenceQueryResponse

Query for user aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1173
1174
1175
1176
 
# File 'lib/purecloud/api/analytics_api.rb', line 1173

def post_users_aggregates_query(opts = {})
  data, status_code, headers = post_users_aggregates_query_with_http_info(opts)
  return data
end

#post_users_aggregates_query_with_http_info(opts = {}) ⇒ Array<(PresenceQueryResponse, Fixnum, Hash)>

Query for user aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PresenceQueryResponse data, response status code and response headers



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
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
 
# File 'lib/purecloud/api/analytics_api.rb', line 1183

def post_users_aggregates_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_users_aggregates_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/users/aggregates/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,
    :return_type => 'PresenceQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_users_observations_query(opts = {}) ⇒ ObservationQueryResponse

Query for user observations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1231
1232
1233
1234
 
# File 'lib/purecloud/api/analytics_api.rb', line 1231

def post_users_observations_query(opts = {})
  data, status_code, headers = post_users_observations_query_with_http_info(opts)
  return data
end

#post_users_observations_query_with_http_info(opts = {}) ⇒ Array<(ObservationQueryResponse, Fixnum, Hash)>

Query for user observations

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ObservationQueryResponse data, response status code and response headers



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'lib/purecloud/api/analytics_api.rb', line 1241

def post_users_observations_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#post_users_observations_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/users/observations/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,
    :return_type => 'ObservationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#post_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_reporting_schedules_schedule_id(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:



675
676
677
678
 
# File 'lib/purecloud/api/analytics_api.rb', line 675

def put_reporting_schedules_schedule_id(schedule_id, opts = {})
  data, status_code, headers = put_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
  return data
end

#put_reporting_schedules_schedule_id_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



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/purecloud/api/analytics_api.rb', line 686

def put_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi#put_reporting_schedules_schedule_id ..."
  end
  
  # verify the required parameter 'schedule_id' is set
  fail "Missing the required parameter 'schedule_id' when calling put_reporting_schedules_schedule_id" if schedule_id.nil?
  
  # resource path
  path = "/api/v2/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#put_reporting_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end