PureCloudPlatform\Client\V2\AnalyticsApi

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

Method	HTTP request	Description
deleteAnalyticsConversationsDetailsJob	DELETE /api/v2/analytics/conversations/details/jobs/{jobId}	Delete/cancel an async request
deleteAnalyticsReportingSchedule	DELETE /api/v2/analytics/reporting/schedules/{scheduleId}	Delete a scheduled report job.
getAnalyticsConversationDetails	GET /api/v2/analytics/conversations/{conversationId}/details	Get a conversation by id
getAnalyticsConversationsDetails	GET /api/v2/analytics/conversations/details	Gets multiple conversations by id
getAnalyticsConversationsDetailsJob	GET /api/v2/analytics/conversations/details/jobs/{jobId}	Get status for async query for conversation details
getAnalyticsConversationsDetailsJobResults	GET /api/v2/analytics/conversations/details/jobs/{jobId}/results	Fetch a page of results for an async query
getAnalyticsReportingExports	GET /api/v2/analytics/reporting/exports	Get all view export requests for a user
getAnalyticsReportingMetadata	GET /api/v2/analytics/reporting/metadata	Get list of reporting metadata.
getAnalyticsReportingReportIdMetadata	GET /api/v2/analytics/reporting/{reportId}/metadata	Get a reporting metadata.
getAnalyticsReportingReportformats	GET /api/v2/analytics/reporting/reportformats	Get a list of report formats
getAnalyticsReportingSchedule	GET /api/v2/analytics/reporting/schedules/{scheduleId}	Get a scheduled report job.
getAnalyticsReportingScheduleHistory	GET /api/v2/analytics/reporting/schedules/{scheduleId}/history	Get list of completed scheduled report jobs.
getAnalyticsReportingScheduleHistoryLatest	GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest	Get most recently completed scheduled report job.
getAnalyticsReportingScheduleHistoryRunId	GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}	A completed scheduled report job
getAnalyticsReportingSchedules	GET /api/v2/analytics/reporting/schedules	Get a list of scheduled report jobs
getAnalyticsReportingTimeperiods	GET /api/v2/analytics/reporting/timeperiods	Get a list of report time periods.
postAnalyticsConversationDetailsProperties	POST /api/v2/analytics/conversations/{conversationId}/details/properties	Index conversation properties
postAnalyticsConversationsAggregatesQuery	POST /api/v2/analytics/conversations/aggregates/query	Query for conversation aggregates
postAnalyticsConversationsDetailsJobs	POST /api/v2/analytics/conversations/details/jobs	Query for conversation details asynchronously
postAnalyticsConversationsDetailsQuery	POST /api/v2/analytics/conversations/details/query	Query for conversation details
postAnalyticsEvaluationsAggregatesQuery	POST /api/v2/analytics/evaluations/aggregates/query	Query for evaluation aggregates
postAnalyticsFlowsAggregatesQuery	POST /api/v2/analytics/flows/aggregates/query	Query for flow aggregates
postAnalyticsFlowsObservationsQuery	POST /api/v2/analytics/flows/observations/query	Query for flow observations
postAnalyticsQueuesObservationsQuery	POST /api/v2/analytics/queues/observations/query	Query for queue observations
postAnalyticsReportingExports	POST /api/v2/analytics/reporting/exports	Generate a view export request
postAnalyticsReportingScheduleRunreport	POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport	Place a scheduled report immediately into the reporting queue
postAnalyticsReportingSchedules	POST /api/v2/analytics/reporting/schedules	Create a scheduled report job
postAnalyticsSurveysAggregatesQuery	POST /api/v2/analytics/surveys/aggregates/query	Query for survey aggregates
postAnalyticsUsersAggregatesQuery	POST /api/v2/analytics/users/aggregates/query	Query for user aggregates
postAnalyticsUsersDetailsQuery	POST /api/v2/analytics/users/details/query	Query for user details
postAnalyticsUsersObservationsQuery	POST /api/v2/analytics/users/observations/query	Query for user observations
putAnalyticsReportingSchedule	PUT /api/v2/analytics/reporting/schedules/{scheduleId}	Update a scheduled report job.

deleteAnalyticsConversationsDetailsJob

deleteAnalyticsConversationsDetailsJob($jobId)

Delete/cancel an async request

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$jobId = "jobId_example"; // string | jobId

try {
    $apiInstance->deleteAnalyticsConversationsDetailsJob($jobId);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->deleteAnalyticsConversationsDetailsJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
jobId	string	jobId

Return type

void (empty response body)

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAnalyticsReportingSchedule

deleteAnalyticsReportingSchedule($scheduleId)

Delete a scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID

try {
    $apiInstance->deleteAnalyticsReportingSchedule($scheduleId);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->deleteAnalyticsReportingSchedule: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID

Return type

void (empty response body)

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsConversationDetails

\PureCloudPlatform\Client\V2\Model\AnalyticsConversation getAnalyticsConversationDetails($conversationId)

Get a conversation by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$conversationId = "conversationId_example"; // string | conversationId

try {
    $result = $apiInstance->getAnalyticsConversationDetails($conversationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsConversationDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversationId	string	conversationId

Return type

\PureCloudPlatform\Client\V2\Model\AnalyticsConversation

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsConversationsDetails

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationMultiGetResponse getAnalyticsConversationsDetails($id)

Gets multiple conversations by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = array("id_example"); // string[] | Comma-separated conversation ids

try {
    $result = $apiInstance->getAnalyticsConversationsDetails($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsConversationsDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string[]	Comma-separated conversation ids	[optional]

Return type

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationMultiGetResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsConversationsDetailsJob

\PureCloudPlatform\Client\V2\Model\AsyncQueryStatus getAnalyticsConversationsDetailsJob($jobId)

Get status for async query for conversation details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$jobId = "jobId_example"; // string | jobId

try {
    $result = $apiInstance->getAnalyticsConversationsDetailsJob($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsConversationsDetailsJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
jobId	string	jobId

Return type

\PureCloudPlatform\Client\V2\Model\AsyncQueryStatus

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsConversationsDetailsJobResults

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationAsyncQueryResponse getAnalyticsConversationsDetailsJobResults($jobId, $cursor)

Fetch a page of results for an async query

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$jobId = "jobId_example"; // string | jobId
$cursor = "cursor_example"; // string | Indicates where to resume query results (not required for first page)

try {
    $result = $apiInstance->getAnalyticsConversationsDetailsJobResults($jobId, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsConversationsDetailsJobResults: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
jobId	string	jobId
cursor	string	Indicates where to resume query results (not required for first page)	[optional]

Return type

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationAsyncQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingExports

\PureCloudPlatform\Client\V2\Model\ReportingExportJobListing getAnalyticsReportingExports()

Get all view export requests for a user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAnalyticsReportingExports();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingExports: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\PureCloudPlatform\Client\V2\Model\ReportingExportJobListing

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingMetadata

\PureCloudPlatform\Client\V2\Model\ReportMetaDataEntityListing getAnalyticsReportingMetadata($pageNumber, $pageSize, $locale)

Get list of reporting metadata.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pageNumber = 1; // int | Page number
$pageSize = 25; // int | Page size
$locale = "locale_example"; // string | Locale

try {
    $result = $apiInstance->getAnalyticsReportingMetadata($pageNumber, $pageSize, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingMetadata: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pageNumber	int	Page number	[optional] [default to 1]
pageSize	int	Page size	[optional] [default to 25]
locale	string	Locale	[optional]

Return type

\PureCloudPlatform\Client\V2\Model\ReportMetaDataEntityListing

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingReportIdMetadata

\PureCloudPlatform\Client\V2\Model\ReportMetaData getAnalyticsReportingReportIdMetadata($reportId, $locale)

Get a reporting metadata.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$reportId = "reportId_example"; // string | Report ID
$locale = "locale_example"; // string | Locale

try {
    $result = $apiInstance->getAnalyticsReportingReportIdMetadata($reportId, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingReportIdMetadata: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
reportId	string	Report ID
locale	string	Locale	[optional]

Return type

\PureCloudPlatform\Client\V2\Model\ReportMetaData

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingReportformats

string[] getAnalyticsReportingReportformats()

Get a list of report formats

Get a list of report formats.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAnalyticsReportingReportformats();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingReportformats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string[]

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingSchedule

\PureCloudPlatform\Client\V2\Model\ReportSchedule getAnalyticsReportingSchedule($scheduleId)

Get a scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID

try {
    $result = $apiInstance->getAnalyticsReportingSchedule($scheduleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingSchedule: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID

Return type

\PureCloudPlatform\Client\V2\Model\ReportSchedule

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingScheduleHistory

\PureCloudPlatform\Client\V2\Model\ReportRunEntryEntityDomainListing getAnalyticsReportingScheduleHistory($scheduleId, $pageNumber, $pageSize)

Get list of completed scheduled report jobs.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID
$pageNumber = 1; // int | 
$pageSize = 25; // int | 

try {
    $result = $apiInstance->getAnalyticsReportingScheduleHistory($scheduleId, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingScheduleHistory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID
pageNumber	int		[optional] [default to 1]
pageSize	int		[optional] [default to 25]

Return type

\PureCloudPlatform\Client\V2\Model\ReportRunEntryEntityDomainListing

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingScheduleHistoryLatest

\PureCloudPlatform\Client\V2\Model\ReportRunEntry getAnalyticsReportingScheduleHistoryLatest($scheduleId)

Get most recently completed scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID

try {
    $result = $apiInstance->getAnalyticsReportingScheduleHistoryLatest($scheduleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingScheduleHistoryLatest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID

Return type

\PureCloudPlatform\Client\V2\Model\ReportRunEntry

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingScheduleHistoryRunId

\PureCloudPlatform\Client\V2\Model\ReportRunEntry getAnalyticsReportingScheduleHistoryRunId($runId, $scheduleId)

A completed scheduled report job

A completed scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$runId = "runId_example"; // string | Run ID
$scheduleId = "scheduleId_example"; // string | Schedule ID

try {
    $result = $apiInstance->getAnalyticsReportingScheduleHistoryRunId($runId, $scheduleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingScheduleHistoryRunId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
runId	string	Run ID
scheduleId	string	Schedule ID

Return type

\PureCloudPlatform\Client\V2\Model\ReportRunEntry

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingSchedules

\PureCloudPlatform\Client\V2\Model\ReportScheduleEntityListing getAnalyticsReportingSchedules($pageNumber, $pageSize)

Get a list of scheduled report jobs

Get a list of scheduled report jobs.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pageNumber = 1; // int | Page number
$pageSize = 25; // int | Page size

try {
    $result = $apiInstance->getAnalyticsReportingSchedules($pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingSchedules: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pageNumber	int	Page number	[optional] [default to 1]
pageSize	int	Page size	[optional] [default to 25]

Return type

\PureCloudPlatform\Client\V2\Model\ReportScheduleEntityListing

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnalyticsReportingTimeperiods

string[] getAnalyticsReportingTimeperiods()

Get a list of report time periods.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAnalyticsReportingTimeperiods();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsReportingTimeperiods: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string[]

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsConversationDetailsProperties

\PureCloudPlatform\Client\V2\Model\PropertyIndexRequest postAnalyticsConversationDetailsProperties($conversationId, $body)

Index conversation properties

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$conversationId = "conversationId_example"; // string | conversationId
$body = new \PureCloudPlatform\Client\V2\Model\PropertyIndexRequest(); // \PureCloudPlatform\Client\V2\Model\PropertyIndexRequest | request

try {
    $result = $apiInstance->postAnalyticsConversationDetailsProperties($conversationId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsConversationDetailsProperties: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversationId	string	conversationId
body	\PureCloudPlatform\Client\V2\Model\PropertyIndexRequest	request

Return type

\PureCloudPlatform\Client\V2\Model\PropertyIndexRequest

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsConversationsAggregatesQuery

\PureCloudPlatform\Client\V2\Model\ConversationAggregateQueryResponse postAnalyticsConversationsAggregatesQuery($body)

Query for conversation aggregates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\ConversationAggregationQuery(); // \PureCloudPlatform\Client\V2\Model\ConversationAggregationQuery | query

try {
    $result = $apiInstance->postAnalyticsConversationsAggregatesQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsConversationsAggregatesQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\ConversationAggregationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\ConversationAggregateQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsConversationsDetailsJobs

\PureCloudPlatform\Client\V2\Model\AsyncQueryResponse postAnalyticsConversationsDetailsJobs($body)

Query for conversation details asynchronously

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\AsyncConversationQuery(); // \PureCloudPlatform\Client\V2\Model\AsyncConversationQuery | query

try {
    $result = $apiInstance->postAnalyticsConversationsDetailsJobs($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsConversationsDetailsJobs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\AsyncConversationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\AsyncQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsConversationsDetailsQuery

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationQueryResponse postAnalyticsConversationsDetailsQuery($body)

Query for conversation details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\ConversationQuery(); // \PureCloudPlatform\Client\V2\Model\ConversationQuery | query

try {
    $result = $apiInstance->postAnalyticsConversationsDetailsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsConversationsDetailsQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\ConversationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\AnalyticsConversationQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsEvaluationsAggregatesQuery

\PureCloudPlatform\Client\V2\Model\EvaluationAggregateQueryResponse postAnalyticsEvaluationsAggregatesQuery($body)

Query for evaluation aggregates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\EvaluationAggregationQuery(); // \PureCloudPlatform\Client\V2\Model\EvaluationAggregationQuery | query

try {
    $result = $apiInstance->postAnalyticsEvaluationsAggregatesQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsEvaluationsAggregatesQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\EvaluationAggregationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\EvaluationAggregateQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsFlowsAggregatesQuery

\PureCloudPlatform\Client\V2\Model\FlowAggregateQueryResponse postAnalyticsFlowsAggregatesQuery($body)

Query for flow aggregates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\FlowAggregationQuery(); // \PureCloudPlatform\Client\V2\Model\FlowAggregationQuery | query

try {
    $result = $apiInstance->postAnalyticsFlowsAggregatesQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsFlowsAggregatesQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\FlowAggregationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\FlowAggregateQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsFlowsObservationsQuery

\PureCloudPlatform\Client\V2\Model\FlowObservationQueryResponse postAnalyticsFlowsObservationsQuery($body)

Query for flow observations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\FlowObservationQuery(); // \PureCloudPlatform\Client\V2\Model\FlowObservationQuery | query

try {
    $result = $apiInstance->postAnalyticsFlowsObservationsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsFlowsObservationsQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\FlowObservationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\FlowObservationQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsQueuesObservationsQuery

\PureCloudPlatform\Client\V2\Model\QueueObservationQueryResponse postAnalyticsQueuesObservationsQuery($body)

Query for queue observations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\QueueObservationQuery(); // \PureCloudPlatform\Client\V2\Model\QueueObservationQuery | query

try {
    $result = $apiInstance->postAnalyticsQueuesObservationsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsQueuesObservationsQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\QueueObservationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\QueueObservationQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsReportingExports

\PureCloudPlatform\Client\V2\Model\ReportingExportJobResponse postAnalyticsReportingExports($body)

Generate a view export request

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\ReportingExportJobRequest(); // \PureCloudPlatform\Client\V2\Model\ReportingExportJobRequest | ReportingExportJobRequest

try {
    $result = $apiInstance->postAnalyticsReportingExports($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsReportingExports: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\ReportingExportJobRequest	ReportingExportJobRequest

Return type

\PureCloudPlatform\Client\V2\Model\ReportingExportJobResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsReportingScheduleRunreport

\PureCloudPlatform\Client\V2\Model\RunNowResponse postAnalyticsReportingScheduleRunreport($scheduleId)

Place a scheduled report immediately into the reporting queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID

try {
    $result = $apiInstance->postAnalyticsReportingScheduleRunreport($scheduleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsReportingScheduleRunreport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID

Return type

\PureCloudPlatform\Client\V2\Model\RunNowResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsReportingSchedules

\PureCloudPlatform\Client\V2\Model\ReportSchedule postAnalyticsReportingSchedules($body)

Create a scheduled report job

Create a scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\ReportSchedule(); // \PureCloudPlatform\Client\V2\Model\ReportSchedule | ReportSchedule

try {
    $result = $apiInstance->postAnalyticsReportingSchedules($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsReportingSchedules: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\ReportSchedule	ReportSchedule

Return type

\PureCloudPlatform\Client\V2\Model\ReportSchedule

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsSurveysAggregatesQuery

\PureCloudPlatform\Client\V2\Model\SurveyAggregateQueryResponse postAnalyticsSurveysAggregatesQuery($body)

Query for survey aggregates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\SurveyAggregationQuery(); // \PureCloudPlatform\Client\V2\Model\SurveyAggregationQuery | query

try {
    $result = $apiInstance->postAnalyticsSurveysAggregatesQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsSurveysAggregatesQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\SurveyAggregationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\SurveyAggregateQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsUsersAggregatesQuery

\PureCloudPlatform\Client\V2\Model\UserAggregateQueryResponse postAnalyticsUsersAggregatesQuery($body)

Query for user aggregates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\UserAggregationQuery(); // \PureCloudPlatform\Client\V2\Model\UserAggregationQuery | query

try {
    $result = $apiInstance->postAnalyticsUsersAggregatesQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsUsersAggregatesQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\UserAggregationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\UserAggregateQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsUsersDetailsQuery

\PureCloudPlatform\Client\V2\Model\AnalyticsUserDetailsQueryResponse postAnalyticsUsersDetailsQuery($body)

Query for user details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\UserDetailsQuery(); // \PureCloudPlatform\Client\V2\Model\UserDetailsQuery | query

try {
    $result = $apiInstance->postAnalyticsUsersDetailsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsUsersDetailsQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\UserDetailsQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\AnalyticsUserDetailsQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAnalyticsUsersObservationsQuery

\PureCloudPlatform\Client\V2\Model\UserObservationQueryResponse postAnalyticsUsersObservationsQuery($body)

Query for user observations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \PureCloudPlatform\Client\V2\Model\UserObservationQuery(); // \PureCloudPlatform\Client\V2\Model\UserObservationQuery | query

try {
    $result = $apiInstance->postAnalyticsUsersObservationsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postAnalyticsUsersObservationsQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\PureCloudPlatform\Client\V2\Model\UserObservationQuery	query

Return type

\PureCloudPlatform\Client\V2\Model\UserObservationQueryResponse

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putAnalyticsReportingSchedule

\PureCloudPlatform\Client\V2\Model\ReportSchedule putAnalyticsReportingSchedule($scheduleId, $body)

Update a scheduled report job.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PureCloud OAuth
$config = PureCloudPlatform\Client\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PureCloudPlatform\Client\V2\Api\AnalyticsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$scheduleId = "scheduleId_example"; // string | Schedule ID
$body = new \PureCloudPlatform\Client\V2\Model\ReportSchedule(); // \PureCloudPlatform\Client\V2\Model\ReportSchedule | ReportSchedule

try {
    $result = $apiInstance->putAnalyticsReportingSchedule($scheduleId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->putAnalyticsReportingSchedule: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
scheduleId	string	Schedule ID
body	\PureCloudPlatform\Client\V2\Model\ReportSchedule	ReportSchedule

Return type

\PureCloudPlatform\Client\V2\Model\ReportSchedule

Authorization

[PureCloud OAuth](../../README.md#PureCloud OAuth)

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AnalyticsApi.md

Latest commit

History

AnalyticsApi.md

File metadata and controls

PureCloudPlatform\Client\V2\AnalyticsApi

deleteAnalyticsConversationsDetailsJob

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAnalyticsReportingSchedule

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsConversationDetails

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsConversationsDetails

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsConversationsDetailsJob

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsConversationsDetailsJobResults

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingExports

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingMetadata

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingReportIdMetadata

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingReportformats

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingSchedule

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingScheduleHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalyticsReportingScheduleHistoryLatest