Get Analytics Overview

Get the overview of omnichannel analytics in your workspace.
It requires the view-livechat-manager permission.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/analytics/overview
​yes​
Query Parameters
Key
Example Value
Description
name*
Conversations
The data that you want to get. The available options are: 
Conversations
Productivity
from*
2019-05-22T12:11:45.392Z
The start date
to*
2023-05-22T12:11:45.392Z
The end date
departmentId
jsi9w0oakusss
The department ID to return results for.
Example Call
curl -L -X GET 'http://localhost:3000/api/v1/livechat/analytics/overview?name=Conversations&from=2019-05-22T12%3A11%3A45.392Z&to=2023-05-22T12%3A11%3A45.392Z' \
-H 'x-auth-token: qlHA60g5JQjJJG7C_8MgXoFnOiRQ8X9TWVVq4AcQeFb' \
-H 'x-user-id: rbAXPnMktTFbNpwtJ'
Example Response
[
    {
        "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"
    }
]
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
No Permission: This occurs when the authenticated user doesn't have the  view-livechat-manager permission.
 Authorization
No Permission
{
    "status": "error",
    "message": "You must be logged in to do this."
}
{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Change Log
Version
Description
6.4.0
Added

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/analytics/overview`	yes

Key	Example Value	Description
`name*`	`Conversations`	The data that you want to get. The available options are: Conversations Productivity
`from*`	`2019-05-22T12:11:45.392Z`	The start date
`to*`	`2023-05-22T12:11:45.392Z`	The end date
`departmentId`	`jsi9w0oakusss`	The department ID to return results for.

Version	Description
6.4.0	Added

Last modified 21d ago