Links

Get Conversation Metrics

Retrieves metrics about all conversations.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/analytics/dashboards/conversation-totalizers
yes
Permission required: view-livechat-manager

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

curl --location --request GET 'http://localhost:3000/api/v1/livechat/analytics/dashboards/conversation-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'

Example Response

{
"totalizers": [
{
"title": "Total_conversations",
"value": 20
},
{
"title": "Open_conversations",
"value": 2
},
{
"title": "On_Hold_conversations",
"value": 0
},
{
"title": "Total_messages",
"value": 51
},
{
"title": "Total_visitors",
"value": 5
}
],
"success": true
}
Last modified 3mo ago
Rocket.Chat versions receive support for six months after release.