View the Omnichannel analytics chart data by chart name within a specific duration. On the workspace UI, you can access this feature by going to Administration > Omnichannel > Analytics.
Permission required: view-livechat-manager
Changelog
| Version | Description |
|---|---|
| 7.11.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
Enter the start date from which you want to view the data. Format: YYYY-MM-DD
Enter the end date till which you want to view the data. Format: YYYY-MM-DD
Enter the chart name for which you want to view the analytics. The options are:
Total_conversationsAvg_chat_durationTotal_messagesAvg_first_response_timeAvg_reaction_timeBest_first_response_timeAvg_response_time
Enter the department ID for which you want to view the analytics.
OK
In the response, the dataLabels array is a list of dates within the specified date range. The dataPoints array refers to the chart analytics for the corresponding dates and the chart label.
{
"chartLabel": "Total_conversations",
"dataLabels": [
"10/1",
"10/2",
"10/3",
"10/4",
"10/5",
"10/6"
],
"dataPoints": [
0,
0,
0,
0,
0,
0
],
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}