Get
/api/v1/livechat/analytics/overview
Get the overview of omnichannel analytics in your workspace.
Permission required: view-livechat-manager
Changelog
| Version | Description |
|---|---|
| 6.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
name
stringRequired
The data that you want to get. The available options are: Productivity, Conversations
ExampleConversations
from
stringRequired
The start date
Example2019-05-22T12:11:45.392Z
to
stringRequired
The end date
Example2023-05-22T12:11:45.392Z
departmentId
string
The department ID to return results for.
Examplejsi9w0oakusss
Responses
200
OK
Success Example
[
{
"title": "Total_conversations",
"value": 1086
},
{
"title": "Open_conversations",
"value": 119
},
{
"title": "On_Hold_conversations",
"value": 1
},
{
"title": "Total_messages",
"value": 4892
},
{
"title": "Busiest_day",
"value": "Tuesday"
},
{
"title": "Conversations_per_day",
"value": "0.74"
},
{
"title": "Busiest_time",
"value": "7AM- 8AM"
}
]Array of object
object
title
string
value
OneOf
string
string
integer
integer
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'name' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "must have required property 'from' [invalid-params]",
"errorType": "invalid-params"
}Example 3
{
"success": false,
"error": "must have required property 'to' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Unauthorized
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string