Get Total Abandoned Chats

Gives the total number of abandoned chats (rooms) by department.

HTTP MethodURLRequires Auth

GET

api/v1/livechat/analytics/departments/total-abandoned-chats

Permission required: view-livechat-manager

Query Parameters

This endpoint supports the offset and count parameters from the Paginationquery parameters. The other parameters are as follows:

KeyExample ValueDescription

start*

2020-09-09T00:11:22.345Z

The start date.

end*

2021-09-10T23:59:22.345Z

The end date.

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/analytics/departments/total-abandoned-chats?start=2020-09-10T23:59:22.345Z&end=2021-09-10T23:59:22.345Z' \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Example Response

{
    "departments": [
        {
            "abandonedRooms": 3,
            "_id": "4LCeYmCHHnQ3EDBgf"
        },
        {
            "abandonedRooms": 1,
            "_id": "8MGLTfaKLCbE9CqR8"
        },
        {
            "abandonedRooms": 1,
            "_id": "Yi87Ju7eTHiZQ7CJt"
        },
        {
            "abandonedRooms": 77,
            "_id": "GgYvrkAF63aeQmsh4"
        },
        {
            "abandonedRooms": 12,
            "_id": "sLYp3ry7CRizaP3rJ"
        },
        {
            "abandonedRooms": 12,
            "_id": "BiqbQav59HD2LzXEY"
        },
        {
            "abandonedRooms": 6,
            "_id": "CAJioQNAvLnYWTy8i"
        }
    ],
    "count": 7,
    "offset": 0,
    "total": 7,
    "success": true
}

Last updated

Rocket.Chat versions receive support for six months after release.