chat-totalizers.md

Get Chat Metrics

Retrieves information about the chats.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/analytics/dashboards/chats-totalizers	yes

{% hint style="info" %} Permission required: view-livechat-manager {% endhint %}

Query Parameters

Key	Example Value	Description
start*	2021-07-20T19:00:00.000Z	The start time.
end*	2021-07-21T18:59:59.000Z	The end time.
departmentId	CAJioQNAvLnYWTy8i	The department ID. This parameter is optional.

Example Call

{% code overflow="wrap" %}

curl --location --request GET 'http://localhost:3000/api/v1/livechat/analytics/dashboards/chats-totalizers?departmentId=CAJioQNAvLnYWTy8i&start=2021-07-20T19:00:00.000Z&end=2021-07-21T18:59:59.000Z\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

{% endcode %}

Example Response

{
    "totalizers": [
        {
            "title": "Total_abandoned_chats",
            "value": 1
        },
        {
            "title": "Avg_of_abandoned_chats",
            "value": "11%"
        },
        {
            "title": "Avg_of_chat_duration_time",
            "value": "01:24:56"
        }
    ],
    "success": true
}