doc_out/AnalyticsApi.html.md in purecloud-0.67.1 vs doc_out/AnalyticsApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,44 +4,47 @@
## PureCloud::AnalyticsApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | 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_details_query**](AnalyticsApi.html#post_users_details_query) | **POST** /api/v2/analytics/users/details/query | Query for user details|
-|[**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.|
+[**delete_reporting_schedules_schedule_id**](AnalyticsApi.html#delete_reporting_schedules_schedule_id) | Delete a scheduled report job.
+[**get_conversations_conversation_id_details**](AnalyticsApi.html#get_conversations_conversation_id_details) | Get a conversation by id
+[**get_reporting_metadata**](AnalyticsApi.html#get_reporting_metadata) | Get list of reporting metadata.
+[**get_reporting_report_id_metadata**](AnalyticsApi.html#get_reporting_report_id_metadata) | Get a reporting metadata.
+[**get_reporting_reportformats**](AnalyticsApi.html#get_reporting_reportformats) | Get a list of report formats
+[**get_reporting_schedules**](AnalyticsApi.html#get_reporting_schedules) | Get a list of scheduled report jobs
+[**get_reporting_schedules_schedule_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id) | Get a scheduled report job.
+[**get_reporting_schedules_schedule_id_history**](AnalyticsApi.html#get_reporting_schedules_schedule_id_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 most recently completed scheduled report job.
+[**get_reporting_schedules_schedule_id_history_run_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_run_id) | A completed scheduled report job
+[**get_reporting_timeperiods**](AnalyticsApi.html#get_reporting_timeperiods) | Get a list of report time periods.
+[**post_conversations_aggregates_query**](AnalyticsApi.html#post_conversations_aggregates_query) | Query for conversation aggregates
+[**post_conversations_conversation_id_details_properties**](AnalyticsApi.html#post_conversations_conversation_id_details_properties) | Index conversation properties
+[**post_conversations_details_query**](AnalyticsApi.html#post_conversations_details_query) | Query for conversation details
+[**post_evaluations_aggregates_query**](AnalyticsApi.html#post_evaluations_aggregates_query) | Query for evaluation aggregates
+[**post_queues_observations_query**](AnalyticsApi.html#post_queues_observations_query) | Query for queue observations
+[**post_reporting_schedules**](AnalyticsApi.html#post_reporting_schedules) | Create a scheduled report job
+[**post_reporting_schedules_schedule_id_runreport**](AnalyticsApi.html#post_reporting_schedules_schedule_id_runreport) | Place a scheduled report immediately into the reporting queue
+[**post_users_aggregates_query**](AnalyticsApi.html#post_users_aggregates_query) | Query for user aggregates
+[**post_users_details_query**](AnalyticsApi.html#post_users_details_query) | Query for user details
+[**post_users_observations_query**](AnalyticsApi.html#post_users_observations_query) | Query for user observations
+[**put_reporting_schedules_schedule_id**](AnalyticsApi.html#put_reporting_schedules_schedule_id) | 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.
+Wraps DELETE /api/v2/analytics/reporting/schedules/{scheduleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -94,10 +97,13 @@
Get a conversation by id
+Wraps GET /api/v2/analytics/conversations/{conversationId}/details
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -150,10 +156,13 @@
Get list of reporting metadata.
+Wraps GET /api/v2/analytics/reporting/metadata
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -211,10 +220,13 @@
Get a reporting metadata.
+Wraps GET /api/v2/analytics/reporting/{reportId}/metadata
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -271,10 +283,13 @@
Get a list of report formats
Get a list of report formats.
+Wraps GET /api/v2/analytics/reporting/reportformats
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -321,10 +336,13 @@
Get a list of scheduled report jobs
Get a list of scheduled report jobs.
+Wraps GET /api/v2/analytics/reporting/schedules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -380,10 +398,13 @@
Get a scheduled report job.
+Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -436,10 +457,13 @@
Get list of completed scheduled report jobs.
+Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -498,10 +522,13 @@
Get most recently completed scheduled report job.
+Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -554,10 +581,13 @@
A completed scheduled report job
A completed scheduled report job.
+Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -613,10 +643,13 @@
Get a list of report time periods.
+Wraps GET /api/v2/analytics/reporting/timeperiods
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -663,10 +696,13 @@
Query for conversation aggregates
+Wraps POST /api/v2/analytics/conversations/aggregates/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -719,10 +755,13 @@
Index conversation properties
+Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -778,10 +817,13 @@
Query for conversation details
+Wraps POST /api/v2/analytics/conversations/details/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -834,10 +876,13 @@
Query for evaluation aggregates
+Wraps POST /api/v2/analytics/evaluations/aggregates/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -890,10 +935,13 @@
Query for queue observations
+Wraps POST /api/v2/analytics/queues/observations/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -946,10 +994,13 @@
Create a scheduled report job
Create a scheduled report job.
+Wraps POST /api/v2/analytics/reporting/schedules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1002,10 +1053,13 @@
Place a scheduled report immediately into the reporting queue
+Wraps POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1058,10 +1112,13 @@
Query for user aggregates
+Wraps POST /api/v2/analytics/users/aggregates/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1114,10 +1171,13 @@
Query for user details
+Wraps POST /api/v2/analytics/users/details/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1170,10 +1230,13 @@
Query for user observations
+Wraps POST /api/v2/analytics/users/observations/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1224,9 +1287,12 @@
## -[**ReportSchedule**](ReportSchedule.html) put_reporting_schedules_schedule_id(schedule_id, body)
Update a scheduled report job.
+
+
+Wraps PUT /api/v2/analytics/reporting/schedules/{scheduleId}
### Example
~~~ruby
# load the gem