class PureCloud::AnalyticsApi
Attributes
Public Class Methods
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete/cancel an async request
@param job_id jobId @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 32 def delete_analytics_conversations_details_job(job_id, opts = {}) delete_analytics_conversations_details_job_with_http_info(job_id, opts) return nil end
Delete/cancel an async request
@param job_id jobId @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 42 def delete_analytics_conversations_details_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_conversations_details_job ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.delete_analytics_conversations_details_job" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_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_analytics_conversations_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 96 def delete_analytics_reporting_schedule(schedule_id, opts = {}) delete_analytics_reporting_schedule_with_http_info(schedule_id, opts) return nil end
Delete a scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 106 def delete_analytics_reporting_schedule_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_reporting_schedule ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.delete_analytics_reporting_schedule" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_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_analytics_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete/cancel an async request
@param job_id jobId @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 160 def delete_analytics_users_details_job(job_id, opts = {}) delete_analytics_users_details_job_with_http_info(job_id, opts) return nil end
Delete/cancel an async request
@param job_id jobId @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 170 def delete_analytics_users_details_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_users_details_job ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.delete_analytics_users_details_job" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_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_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a conversation by id
@param conversation_id conversationId @param [Hash] opts the optional parameters @return [AnalyticsConversationWithoutAttributes]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 224 def get_analytics_conversation_details(conversation_id, opts = {}) data, _status_code, _headers = get_analytics_conversation_details_with_http_info(conversation_id, opts) return data end
Get a conversation by id
@param conversation_id conversationId @param [Hash] opts the optional parameters @return [Array<(AnalyticsConversationWithoutAttributes
, Fixnum, Hash)>] AnalyticsConversationWithoutAttributes
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 234 def get_analytics_conversation_details_with_http_info(conversation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversation_details ..." end # verify the required parameter 'conversation_id' is set fail ArgumentError, "Missing the required parameter 'conversation_id' when calling AnalyticsApi.get_analytics_conversation_details" if conversation_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AnalyticsConversationWithoutAttributes') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversation_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets multiple conversations by id
@param [Hash] opts the optional parameters @option opts [Array<String>] :id Comma-separated conversation ids @return [AnalyticsConversationWithoutAttributesMultiGetResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 289 def get_analytics_conversations_details(opts = {}) data, _status_code, _headers = get_analytics_conversations_details_with_http_info(opts) return data end
Get status for async query for conversation details
@param job_id jobId @param [Hash] opts the optional parameters @return [AsyncQueryStatus]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 353 def get_analytics_conversations_details_job(job_id, opts = {}) data, _status_code, _headers = get_analytics_conversations_details_job_with_http_info(job_id, opts) return data end
Fetch a page of results for an async query
@param job_id jobId @param [Hash] opts the optional parameters @option opts [String] :cursor Indicates where to resume query results (not required for first page) @option opts [Integer] :page_size The desired maximum number of results @return [AnalyticsConversationAsyncQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 420 def get_analytics_conversations_details_job_results(job_id, opts = {}) data, _status_code, _headers = get_analytics_conversations_details_job_results_with_http_info(job_id, opts) return data end
Fetch a page of results for an async query
@param job_id jobId @param [Hash] opts the optional parameters @option opts [String] :cursor Indicates where to resume query results (not required for first page) @option opts [Integer] :page_size The desired maximum number of results @return [Array<(AnalyticsConversationAsyncQueryResponse
, Fixnum, Hash)>] AnalyticsConversationAsyncQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 432 def get_analytics_conversations_details_job_results_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversations_details_job_results ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_conversations_details_job_results" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor'] query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AnalyticsConversationAsyncQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversations_details_job_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get status for async query for conversation details
@param job_id jobId @param [Hash] opts the optional parameters @return [Array<(AsyncQueryStatus
, Fixnum, Hash)>] AsyncQueryStatus
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 363 def get_analytics_conversations_details_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversations_details_job ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_conversations_details_job" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AsyncQueryStatus') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversations_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets multiple conversations by id
@param [Hash] opts the optional parameters @option opts [Array<String>] :id Comma-separated conversation ids @return [Array<(AnalyticsConversationWithoutAttributesMultiGetResponse
, Fixnum, Hash)>] AnalyticsConversationWithoutAttributesMultiGetResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 299 def get_analytics_conversations_details_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversations_details ..." end # resource path local_var_path = "/api/v2/analytics/conversations/details".sub('{format}','json') # query parameters query_params = {} query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AnalyticsConversationWithoutAttributesMultiGetResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversations_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all view export requests for a user
@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number (default to 1) @option opts [Integer] :page_size Page
size (default to 25) @return [ReportingExportJobListing]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 502 def get_analytics_reporting_exports(opts = {}) data, _status_code, _headers = get_analytics_reporting_exports_with_http_info(opts) return data end
Get all export metadata
@param [Hash] opts the optional parameters @return [ReportingExportMetadataJobListing]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 573 def get_analytics_reporting_exports_metadata(opts = {}) data, _status_code, _headers = get_analytics_reporting_exports_metadata_with_http_info(opts) return data end
Get all export metadata
@param [Hash] opts the optional parameters @return [Array<(ReportingExportMetadataJobListing
, Fixnum, Hash)>] ReportingExportMetadataJobListing
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 582 def get_analytics_reporting_exports_metadata_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_exports_metadata ..." end # resource path local_var_path = "/api/v2/analytics/reporting/exports/metadata".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportingExportMetadataJobListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_exports_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all view export requests for a user
@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number @option opts [Integer] :page_size Page
size @return [Array<(ReportingExportJobListing
, Fixnum, Hash)>] ReportingExportJobListing
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 513 def get_analytics_reporting_exports_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_exports ..." end # resource path local_var_path = "/api/v2/analytics/reporting/exports".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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportingExportJobListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of reporting metadata.
@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number (default to 1) @option opts [Integer] :page_size Page
size (default to 25) @option opts [String] :locale Locale @return [ReportMetaDataEntityListing]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 631 def get_analytics_reporting_metadata(opts = {}) data, _status_code, _headers = get_analytics_reporting_metadata_with_http_info(opts) return data end
Get list of reporting metadata.
@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number @option opts [Integer] :page_size Page
size @option opts [String] :locale Locale @return [Array<(ReportMetaDataEntityListing
, Fixnum, Hash)>] ReportMetaDataEntityListing
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 643 def get_analytics_reporting_metadata_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_metadata ..." end # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportMetaDataEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a reporting metadata.
@param report_id Report ID @param [Hash] opts the optional parameters @option opts [String] :locale Locale @return [ReportMetaData]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 712 def get_analytics_reporting_report_id_metadata(report_id, opts = {}) data, _status_code, _headers = get_analytics_reporting_report_id_metadata_with_http_info(report_id, opts) return data end
Get a reporting metadata.
@param report_id Report ID @param [Hash] opts the optional parameters @option opts [String] :locale Locale @return [Array<(ReportMetaData
, Fixnum, Hash)>] ReportMetaData
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 723 def get_analytics_reporting_report_id_metadata_with_http_info(report_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_report_id_metadata ..." end # verify the required parameter 'report_id' is set fail ArgumentError, "Missing the required parameter 'report_id' when calling AnalyticsApi.get_analytics_reporting_report_id_metadata" if report_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportMetaData') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_report_id_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of report formats Get a list of report formats. @param [Hash] opts the optional parameters @return [Array<String>]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 784 def get_analytics_reporting_reportformats(opts = {}) data, _status_code, _headers = get_analytics_reporting_reportformats_with_http_info(opts) return data end
Get a list of report formats Get a list of report formats. @param [Hash] opts the optional parameters @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 793 def get_analytics_reporting_reportformats_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_reportformats ..." end # resource path local_var_path = "/api/v2/analytics/reporting/reportformats".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<String>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_reportformats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [ReportSchedule]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 840 def get_analytics_reporting_schedule(schedule_id, opts = {}) data, _status_code, _headers = get_analytics_reporting_schedule_with_http_info(schedule_id, opts) return data end
Get list of completed scheduled report jobs.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number (default to 1) @option opts [Integer] :page_size (default to 25) @return [ReportRunEntryEntityDomainListing]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 907 def get_analytics_reporting_schedule_history(schedule_id, opts = {}) data, _status_code, _headers = get_analytics_reporting_schedule_history_with_http_info(schedule_id, opts) return data end
Get most recently completed scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [ReportRunEntry]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 988 def get_analytics_reporting_schedule_history_latest(schedule_id, opts = {}) data, _status_code, _headers = get_analytics_reporting_schedule_history_latest_with_http_info(schedule_id, opts) return data end
Get most recently completed scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [Array<(ReportRunEntry
, Fixnum, Hash)>] ReportRunEntry
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 998 def get_analytics_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule_history_latest ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_latest" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportRunEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_schedule_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
A completed scheduled report job A completed scheduled report job. @param run_id Run ID @param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [ReportRunEntry]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1054 def get_analytics_reporting_schedule_history_run_id(run_id, schedule_id, opts = {}) data, _status_code, _headers = get_analytics_reporting_schedule_history_run_id_with_http_info(run_id, schedule_id, opts) return data end
A completed scheduled report job A completed scheduled report job. @param run_id Run ID @param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [Array<(ReportRunEntry
, Fixnum, Hash)>] ReportRunEntry
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1065 def get_analytics_reporting_schedule_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_analytics_reporting_schedule_history_run_id ..." end # verify the required parameter 'run_id' is set fail ArgumentError, "Missing the required parameter 'run_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_run_id" if run_id.nil? # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_run_id" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportRunEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_schedule_history_run_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of completed scheduled report jobs.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number @option opts [Integer] :page_size @return [Array<(ReportRunEntryEntityDomainListing
, Fixnum, Hash)>] ReportRunEntryEntityDomainListing
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 919 def get_analytics_reporting_schedule_history_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule_history ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportRunEntryEntityDomainListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_schedule_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a scheduled report job.
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [Array<(ReportSchedule
, Fixnum, Hash)>] ReportSchedule
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 850 def get_analytics_reporting_schedule_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of scheduled report jobs Get a list of scheduled report jobs. @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number (default to 1) @option opts [Integer] :page_size Page
size (default to 25) @return [ReportScheduleEntityListing]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1129 def get_analytics_reporting_schedules(opts = {}) data, _status_code, _headers = get_analytics_reporting_schedules_with_http_info(opts) return data end
Get a list of scheduled report jobs Get a list of scheduled report jobs. @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page
number @option opts [Integer] :page_size Page
size @return [Array<(ReportScheduleEntityListing
, Fixnum, Hash)>] ReportScheduleEntityListing
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1140 def get_analytics_reporting_schedules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedules ..." end # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportScheduleEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of report time periods.
@param [Hash] opts the optional parameters @return [Array<String>]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1200 def get_analytics_reporting_timeperiods(opts = {}) data, _status_code, _headers = get_analytics_reporting_timeperiods_with_http_info(opts) return data end
Get a list of report time periods.
@param [Hash] opts the optional parameters @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1209 def get_analytics_reporting_timeperiods_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_timeperiods ..." end # resource path local_var_path = "/api/v2/analytics/reporting/timeperiods".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<String>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_timeperiods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get status for async query for user details
@param job_id jobId @param [Hash] opts the optional parameters @return [AsyncQueryStatus]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1256 def get_analytics_users_details_job(job_id, opts = {}) data, _status_code, _headers = get_analytics_users_details_job_with_http_info(job_id, opts) return data end
Fetch a page of results for an async query
@param job_id jobId @param [Hash] opts the optional parameters @option opts [String] :cursor Indicates where to resume query results (not required for first page) @option opts [Integer] :page_size The desired maximum number of results @return [AnalyticsUserDetailsAsyncQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1323 def get_analytics_users_details_job_results(job_id, opts = {}) data, _status_code, _headers = get_analytics_users_details_job_results_with_http_info(job_id, opts) return data end
Fetch a page of results for an async query
@param job_id jobId @param [Hash] opts the optional parameters @option opts [String] :cursor Indicates where to resume query results (not required for first page) @option opts [Integer] :page_size The desired maximum number of results @return [Array<(AnalyticsUserDetailsAsyncQueryResponse
, Fixnum, Hash)>] AnalyticsUserDetailsAsyncQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1335 def get_analytics_users_details_job_results_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_users_details_job_results ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_users_details_job_results" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor'] query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AnalyticsUserDetailsAsyncQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_users_details_job_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get status for async query for user details
@param job_id jobId @param [Hash] opts the optional parameters @return [Array<(AsyncQueryStatus
, Fixnum, Hash)>] AsyncQueryStatus
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1266 def get_analytics_users_details_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_users_details_job ..." end # verify the required parameter 'job_id' is set fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_users_details_job" if job_id.nil? # resource path local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AsyncQueryStatus') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Index conversation properties
@param conversation_id conversationId @param body request @param [Hash] opts the optional parameters @return [PropertyIndexRequest]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1405 def post_analytics_conversation_details_properties(conversation_id, body, opts = {}) data, _status_code, _headers = post_analytics_conversation_details_properties_with_http_info(conversation_id, body, opts) return data end
Index conversation properties
@param conversation_id conversationId @param body request @param [Hash] opts the optional parameters @return [Array<(PropertyIndexRequest
, Fixnum, Hash)>] PropertyIndexRequest
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1416 def post_analytics_conversation_details_properties_with_http_info(conversation_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversation_details_properties ..." end # verify the required parameter 'conversation_id' is set fail ArgumentError, "Missing the required parameter 'conversation_id' when calling AnalyticsApi.post_analytics_conversation_details_properties" if conversation_id.nil? # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversation_details_properties" if body.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_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_analytics_conversation_details_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for conversation aggregates
@param body query @param [Hash] opts the optional parameters @return [ConversationAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1479 def post_analytics_conversations_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_conversations_aggregates_query_with_http_info(body, opts) return data end
Query for conversation aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(ConversationAggregateQueryResponse
, Fixnum, Hash)>] ConversationAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1489 def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/conversations/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConversationAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for conversation details asynchronously
@param body query @param [Hash] opts the optional parameters @return [AsyncQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1544 def post_analytics_conversations_details_jobs(body, opts = {}) data, _status_code, _headers = post_analytics_conversations_details_jobs_with_http_info(body, opts) return data end
Query for conversation details asynchronously
@param body query @param [Hash] opts the optional parameters @return [Array<(AsyncQueryResponse
, Fixnum, Hash)>] AsyncQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1554 def post_analytics_conversations_details_jobs_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_details_jobs ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_details_jobs" if body.nil? # resource path local_var_path = "/api/v2/analytics/conversations/details/jobs".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AsyncQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_conversations_details_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for conversation details
@param body query @param [Hash] opts the optional parameters @return [AnalyticsConversationQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1609 def post_analytics_conversations_details_query(body, opts = {}) data, _status_code, _headers = post_analytics_conversations_details_query_with_http_info(body, opts) return data end
Query for conversation details
@param body query @param [Hash] opts the optional parameters @return [Array<(AnalyticsConversationQueryResponse
, Fixnum, Hash)>] AnalyticsConversationQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1619 def post_analytics_conversations_details_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_details_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_details_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/conversations/details/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_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_analytics_conversations_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for evaluation aggregates
@param body query @param [Hash] opts the optional parameters @return [EvaluationAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1674 def post_analytics_evaluations_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts) return data end
Query for evaluation aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(EvaluationAggregateQueryResponse
, Fixnum, Hash)>] EvaluationAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1684 def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_evaluations_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_evaluations_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/evaluations/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EvaluationAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for flow aggregates
@param body query @param [Hash] opts the optional parameters @return [FlowAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1739 def post_analytics_flows_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_flows_aggregates_query_with_http_info(body, opts) return data end
Query for flow aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(FlowAggregateQueryResponse
, Fixnum, Hash)>] FlowAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1749 def post_analytics_flows_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_flows_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/flows/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FlowAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for flow observations
@param body query @param [Hash] opts the optional parameters @return [FlowObservationQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1804 def post_analytics_flows_observations_query(body, opts = {}) data, _status_code, _headers = post_analytics_flows_observations_query_with_http_info(body, opts) return data end
Query for flow observations
@param body query @param [Hash] opts the optional parameters @return [Array<(FlowObservationQueryResponse
, Fixnum, Hash)>] FlowObservationQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1814 def post_analytics_flows_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_observations_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_flows_observations_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/flows/observations/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FlowObservationQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for journey aggregates
@param body query @param [Hash] opts the optional parameters @return [JourneyAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1869 def post_analytics_journeys_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_journeys_aggregates_query_with_http_info(body, opts) return data end
Query for journey aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(JourneyAggregateQueryResponse
, Fixnum, Hash)>] JourneyAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1879 def post_analytics_journeys_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_journeys_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_journeys_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/journeys/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'JourneyAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_journeys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for queue observations
@param body query @param [Hash] opts the optional parameters @return [QueueObservationQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1934 def post_analytics_queues_observations_query(body, opts = {}) data, _status_code, _headers = post_analytics_queues_observations_query_with_http_info(body, opts) return data end
Query for queue observations
@param body query @param [Hash] opts the optional parameters @return [Array<(QueueObservationQueryResponse
, Fixnum, Hash)>] QueueObservationQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1944 def post_analytics_queues_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_queues_observations_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_queues_observations_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/queues/observations/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QueueObservationQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Generate a view export request This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead @param body ReportingExportJobRequest
@param [Hash] opts the optional parameters @return [ReportingExportJobResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 1999 def post_analytics_reporting_exports(body, opts = {}) data, _status_code, _headers = post_analytics_reporting_exports_with_http_info(body, opts) return data end
Generate a view export request This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead @param body ReportingExportJobRequest
@param [Hash] opts the optional parameters @return [Array<(ReportingExportJobResponse
, Fixnum, Hash)>] ReportingExportJobResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2009 def post_analytics_reporting_exports_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_exports ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_reporting_exports" if body.nil? # resource path local_var_path = "/api/v2/analytics/reporting/exports".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ReportingExportJobResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_reporting_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Place a scheduled report immediately into the reporting queue
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [RunNowResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2064 def post_analytics_reporting_schedule_runreport(schedule_id, opts = {}) data, _status_code, _headers = post_analytics_reporting_schedule_runreport_with_http_info(schedule_id, opts) return data end
Place a scheduled report immediately into the reporting queue
@param schedule_id Schedule
ID @param [Hash] opts the optional parameters @return [Array<(RunNowResponse
, Fixnum, Hash)>] RunNowResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2074 def post_analytics_reporting_schedule_runreport_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_schedule_runreport ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.post_analytics_reporting_schedule_runreport" if schedule_id.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_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_analytics_reporting_schedule_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a scheduled report job Create a scheduled report job. @param body ReportSchedule
@param [Hash] opts the optional parameters @return [ReportSchedule]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2129 def post_analytics_reporting_schedules(body, opts = {}) data, _status_code, _headers = post_analytics_reporting_schedules_with_http_info(body, opts) return data end
Create a scheduled report job Create a scheduled report job. @param body ReportSchedule
@param [Hash] opts the optional parameters @return [Array<(ReportSchedule
, Fixnum, Hash)>] ReportSchedule
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2139 def post_analytics_reporting_schedules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_schedules ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_reporting_schedules" if body.nil? # resource path local_var_path = "/api/v2/analytics/reporting/schedules".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_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_analytics_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for survey aggregates
@param body query @param [Hash] opts the optional parameters @return [SurveyAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2194 def post_analytics_surveys_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_surveys_aggregates_query_with_http_info(body, opts) return data end
Query for survey aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(SurveyAggregateQueryResponse
, Fixnum, Hash)>] SurveyAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2204 def post_analytics_surveys_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_surveys_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_surveys_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/surveys/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SurveyAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_surveys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for user aggregates
@param body query @param [Hash] opts the optional parameters @return [UserAggregateQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2259 def post_analytics_users_aggregates_query(body, opts = {}) data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts) return data end
Query for user aggregates
@param body query @param [Hash] opts the optional parameters @return [Array<(UserAggregateQueryResponse
, Fixnum, Hash)>] UserAggregateQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2269 def post_analytics_users_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_aggregates_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_aggregates_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserAggregateQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for user details asynchronously
@param body query @param [Hash] opts the optional parameters @return [AsyncQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2324 def post_analytics_users_details_jobs(body, opts = {}) data, _status_code, _headers = post_analytics_users_details_jobs_with_http_info(body, opts) return data end
Query for user details asynchronously
@param body query @param [Hash] opts the optional parameters @return [Array<(AsyncQueryResponse
, Fixnum, Hash)>] AsyncQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2334 def post_analytics_users_details_jobs_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_details_jobs ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_details_jobs" if body.nil? # resource path local_var_path = "/api/v2/analytics/users/details/jobs".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AsyncQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_details_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for user details
@param body query @param [Hash] opts the optional parameters @return [AnalyticsUserDetailsQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2389 def post_analytics_users_details_query(body, opts = {}) data, _status_code, _headers = post_analytics_users_details_query_with_http_info(body, opts) return data end
Query for user details
@param body query @param [Hash] opts the optional parameters @return [Array<(AnalyticsUserDetailsQueryResponse
, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2399 def post_analytics_users_details_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_details_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_details_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AnalyticsUserDetailsQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Query for user observations
@param body query @param [Hash] opts the optional parameters @return [UserObservationQueryResponse]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2454 def post_analytics_users_observations_query(body, opts = {}) data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts) return data end
Query for user observations
@param body query @param [Hash] opts the optional parameters @return [Array<(UserObservationQueryResponse
, Fixnum, Hash)>] UserObservationQueryResponse
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2464 def post_analytics_users_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_observations_query ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_observations_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/users/observations/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserObservationQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a scheduled report job.
@param schedule_id Schedule
ID @param body ReportSchedule
@param [Hash] opts the optional parameters @return [ReportSchedule]
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2520 def put_analytics_reporting_schedule(schedule_id, body, opts = {}) data, _status_code, _headers = put_analytics_reporting_schedule_with_http_info(schedule_id, body, opts) return data end
Update a scheduled report job.
@param schedule_id Schedule
ID @param body ReportSchedule
@param [Hash] opts the optional parameters @return [Array<(ReportSchedule
, Fixnum, Hash)>] ReportSchedule
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/analytics_api.rb, line 2531 def put_analytics_reporting_schedule_with_http_info(schedule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.put_analytics_reporting_schedule ..." end # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.put_analytics_reporting_schedule" if schedule_id.nil? # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.put_analytics_reporting_schedule" if body.nil? # resource path local_var_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) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_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_analytics_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end