---
title: AnalyticsApi
---

## PureCloud::AnalyticsApi

All URIs are relative to *https://api.mypurecloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
|[**delete_reporting_schedules_schedule_id**](AnalyticsApi.html#delete_reporting_schedules_schedule_id) | **DELETE** /api/v2/analytics/reporting/schedules/{scheduleId} | Delete a scheduled report job.|
|[**get_conversations_conversation_id_details**](AnalyticsApi.html#get_conversations_conversation_id_details) | **GET** /api/v2/analytics/conversations/{conversationId}/details | Get a conversation by id|
|[**get_reporting_metadata**](AnalyticsApi.html#get_reporting_metadata) | **GET** /api/v2/analytics/reporting/metadata | Get list of reporting metadata.|
|[**get_reporting_report_id_metadata**](AnalyticsApi.html#get_reporting_report_id_metadata) | **GET** /api/v2/analytics/reporting/{reportId}/metadata | Get a reporting metadata.|
|[**get_reporting_reportformats**](AnalyticsApi.html#get_reporting_reportformats) | **GET** /api/v2/analytics/reporting/reportformats | Get a list of report formats|
|[**get_reporting_schedules**](AnalyticsApi.html#get_reporting_schedules) | **GET** /api/v2/analytics/reporting/schedules | Get a list of scheduled report jobs|
|[**get_reporting_schedules_schedule_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId} | Get a scheduled report job.|
|[**get_reporting_schedules_schedule_id_history**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history | Get list of completed scheduled report jobs.|
|[**get_reporting_schedules_schedule_id_history_latest**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_latest) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest | Get most recently completed scheduled report job.|
|[**get_reporting_schedules_schedule_id_history_run_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_run_id) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId} | A completed scheduled report job|
|[**get_reporting_timeperiods**](AnalyticsApi.html#get_reporting_timeperiods) | **GET** /api/v2/analytics/reporting/timeperiods | Get a list of report time periods.|
|[**post_conversations_aggregates_query**](AnalyticsApi.html#post_conversations_aggregates_query) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates|
|[**post_conversations_conversation_id_details_properties**](AnalyticsApi.html#post_conversations_conversation_id_details_properties) | **POST** /api/v2/analytics/conversations/{conversationId}/details/properties | Index conversation properties|
|[**post_conversations_details_query**](AnalyticsApi.html#post_conversations_details_query) | **POST** /api/v2/analytics/conversations/details/query | Query for conversation details|
|[**post_evaluations_aggregates_query**](AnalyticsApi.html#post_evaluations_aggregates_query) | **POST** /api/v2/analytics/evaluations/aggregates/query | Query for evaluation aggregates|
|[**post_queues_observations_query**](AnalyticsApi.html#post_queues_observations_query) | **POST** /api/v2/analytics/queues/observations/query | Query for queue observations|
|[**post_reporting_schedules**](AnalyticsApi.html#post_reporting_schedules) | **POST** /api/v2/analytics/reporting/schedules | Create a scheduled report job|
|[**post_reporting_schedules_schedule_id_runreport**](AnalyticsApi.html#post_reporting_schedules_schedule_id_runreport) | **POST** /api/v2/analytics/reporting/schedules/{scheduleId}/runreport | Place a scheduled report immediately into the reporting queue|
|[**post_users_aggregates_query**](AnalyticsApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates|
|[**post_users_observations_query**](AnalyticsApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
|[**put_reporting_schedules_schedule_id**](AnalyticsApi.html#put_reporting_schedules_schedule_id) | **PUT** /api/v2/analytics/reporting/schedules/{scheduleId} | Update a scheduled report job.|
{: class="table table-striped"}

<a name="delete_reporting_schedules_schedule_id"></a>

## -String** delete_reporting_schedules_schedule_id(schedule_id)

Delete a scheduled report job.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Delete a scheduled report job.
  result = api_instance.delete_reporting_schedules_schedule_id(schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->delete_reporting_schedules_schedule_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
{: class="table table-striped"}


### Return type

**String**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversations_conversation_id_details"></a>

## -[**AnalyticsConversation**](AnalyticsConversation.html) get_conversations_conversation_id_details(conversation_id)

Get a conversation by id



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

conversation_id = "conversation_id_example" # String | conversationId


begin
  #Get a conversation by id
  result = api_instance.get_conversations_conversation_id_details(conversation_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_conversations_conversation_id_details: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversationId | 
{: class="table table-striped"}


### Return type

[**AnalyticsConversation**](AnalyticsConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_metadata"></a>

## -[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_reporting_metadata(opts)

Get list of reporting metadata.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  locale: "locale_example" # String | Locale
}

begin
  #Get list of reporting metadata.
  result = api_instance.get_reporting_metadata(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_metadata: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_number** | **Integer**| Page number | [optional] [default to 1]
 **page_size** | **Integer**| Page size | [optional] [default to 25]
 **locale** | **String**| Locale | [optional] 
{: class="table table-striped"}


### Return type

[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_report_id_metadata"></a>

## -[**ReportMetaData**](ReportMetaData.html) get_reporting_report_id_metadata(report_id, opts)

Get a reporting metadata.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

report_id = "report_id_example" # String | Report ID

opts = { 
  locale: "locale_example" # String | Locale
}

begin
  #Get a reporting metadata.
  result = api_instance.get_reporting_report_id_metadata(report_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_report_id_metadata: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **report_id** | **String**| Report ID | 
 **locale** | **String**| Locale | [optional] 
{: class="table table-striped"}


### Return type

[**ReportMetaData**](ReportMetaData.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_reportformats"></a>

## -Array&lt;String&gt;** get_reporting_reportformats

Get a list of report formats

Get a list of report formats.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

begin
  #Get a list of report formats
  result = api_instance.get_reporting_reportformats
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_reportformats: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

**Array&lt;String&gt;**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_schedules"></a>

## -[**ReportScheduleEntityListing**](ReportScheduleEntityListing.html) get_reporting_schedules(opts)

Get a list of scheduled report jobs

Get a list of scheduled report jobs.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25 # Integer | Page size
}

begin
  #Get a list of scheduled report jobs
  result = api_instance.get_reporting_schedules(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_schedules: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_number** | **Integer**| Page number | [optional] [default to 1]
 **page_size** | **Integer**| Page size | [optional] [default to 25]
{: class="table table-striped"}


### Return type

[**ReportScheduleEntityListing**](ReportScheduleEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_schedules_schedule_id"></a>

## -[**ReportSchedule**](ReportSchedule.html) get_reporting_schedules_schedule_id(schedule_id)

Get a scheduled report job.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Get a scheduled report job.
  result = api_instance.get_reporting_schedules_schedule_id(schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
{: class="table table-striped"}


### Return type

[**ReportSchedule**](ReportSchedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_schedules_schedule_id_history"></a>

## -[**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html) get_reporting_schedules_schedule_id_history(schedule_id, opts)

Get list of completed scheduled report jobs.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID

opts = { 
  page_number: 1, # Integer | 
  page_size: 25 # Integer | 
}

begin
  #Get list of completed scheduled report jobs.
  result = api_instance.get_reporting_schedules_schedule_id_history(schedule_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
 **page_number** | **Integer**|  | [optional] [default to 1]
 **page_size** | **Integer**|  | [optional] [default to 25]
{: class="table table-striped"}


### Return type

[**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_schedules_schedule_id_history_latest"></a>

## -[**ReportRunEntry**](ReportRunEntry.html) get_reporting_schedules_schedule_id_history_latest(schedule_id)

Get most recently completed scheduled report job.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Get most recently completed scheduled report job.
  result = api_instance.get_reporting_schedules_schedule_id_history_latest(schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history_latest: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
{: class="table table-striped"}


### Return type

[**ReportRunEntry**](ReportRunEntry.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_schedules_schedule_id_history_run_id"></a>

## -[**ReportRunEntry**](ReportRunEntry.html) get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id)

A completed scheduled report job

A completed scheduled report job.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

run_id = "run_id_example" # String | Run ID

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #A completed scheduled report job
  result = api_instance.get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history_run_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **run_id** | **String**| Run ID | 
 **schedule_id** | **String**| Schedule ID | 
{: class="table table-striped"}


### Return type

[**ReportRunEntry**](ReportRunEntry.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_reporting_timeperiods"></a>

## -Array&lt;String&gt;** get_reporting_timeperiods

Get a list of report time periods.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

begin
  #Get a list of report time periods.
  result = api_instance.get_reporting_timeperiods
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->get_reporting_timeperiods: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

**Array&lt;String&gt;**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_aggregates_query"></a>

## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_conversations_aggregates_query(opts)

Query for conversation aggregates



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::AggregationQuery.new # AggregationQuery | query
}

begin
  #Query for conversation aggregates
  result = api_instance.post_conversations_aggregates_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_conversations_aggregates_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**AggregateQueryResponse**](AggregateQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_conversation_id_details_properties"></a>

## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_conversations_conversation_id_details_properties(conversation_id, opts)

Index conversation properties



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

conversation_id = "conversation_id_example" # String | conversationId

opts = { 
  body: PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request
}

begin
  #Index conversation properties
  result = api_instance.post_conversations_conversation_id_details_properties(conversation_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_conversations_conversation_id_details_properties: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversationId | 
 **body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request | [optional] 
{: class="table table-striped"}


### Return type

[**PropertyIndexRequest**](PropertyIndexRequest.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_details_query"></a>

## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_conversations_details_query(opts)

Query for conversation details



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::ConversationQuery.new # ConversationQuery | query
}

begin
  #Query for conversation details
  result = api_instance.post_conversations_details_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_conversations_details_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ConversationQuery**](ConversationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_evaluations_aggregates_query"></a>

## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(opts)

Query for evaluation aggregates



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::AggregationQuery.new # AggregationQuery | query
}

begin
  #Query for evaluation aggregates
  result = api_instance.post_evaluations_aggregates_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_evaluations_aggregates_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**AggregateQueryResponse**](AggregateQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_queues_observations_query"></a>

## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(opts)

Query for queue observations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::ObservationQuery.new # ObservationQuery | query
}

begin
  #Query for queue observations
  result = api_instance.post_queues_observations_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_queues_observations_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**ObservationQueryResponse**](ObservationQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_reporting_schedules"></a>

## -[**ReportSchedule**](ReportSchedule.html) post_reporting_schedules(opts)

Create a scheduled report job

Create a scheduled report job.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule
}

begin
  #Create a scheduled report job
  result = api_instance.post_reporting_schedules(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_reporting_schedules: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional] 
{: class="table table-striped"}


### Return type

[**ReportSchedule**](ReportSchedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_reporting_schedules_schedule_id_runreport"></a>

## -[**RunNowResponse**](RunNowResponse.html) post_reporting_schedules_schedule_id_runreport(schedule_id)

Place a scheduled report immediately into the reporting queue



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Place a scheduled report immediately into the reporting queue
  result = api_instance.post_reporting_schedules_schedule_id_runreport(schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_reporting_schedules_schedule_id_runreport: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
{: class="table table-striped"}


### Return type

[**RunNowResponse**](RunNowResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_users_aggregates_query"></a>

## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(opts)

Query for user aggregates



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::AggregationQuery.new # AggregationQuery | query
}

begin
  #Query for user aggregates
  result = api_instance.post_users_aggregates_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_users_aggregates_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**PresenceQueryResponse**](PresenceQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_users_observations_query"></a>

## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(opts)

Query for user observations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

opts = { 
  body: PureCloud::ObservationQuery.new # ObservationQuery | query
}

begin
  #Query for user observations
  result = api_instance.post_users_observations_query(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->post_users_observations_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional] 
{: class="table table-striped"}


### Return type

[**ObservationQueryResponse**](ObservationQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_reporting_schedules_schedule_id"></a>

## -[**ReportSchedule**](ReportSchedule.html) put_reporting_schedules_schedule_id(schedule_id, opts)

Update a scheduled report job.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::AnalyticsApi.new

schedule_id = "schedule_id_example" # String | Schedule ID

opts = { 
  body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule
}

begin
  #Update a scheduled report job.
  result = api_instance.put_reporting_schedules_schedule_id(schedule_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling AnalyticsApi->put_reporting_schedules_schedule_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID | 
 **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional] 
{: class="table table-striped"}


### Return type

[**ReportSchedule**](ReportSchedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json