Get Average Waiting Time

Gives the average visitor waiting time (in seconds) by department.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/analytics/departments/average-waiting-time

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*

2020-09-10T23:59:22.345Z

The end date.

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/analytics/departments/average-waiting-time?start=2020-02-12T00:11:22.345Z&end=2020-02-18T23:59:22.345Z' \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Example Response

{
    "departments": [
        {
            "_id": "64181a0728384134ed600dcc",
            "averageWaitingTimeInSeconds": 199
        },
        {
            "_id": "649230d479f5c6e276cf4a12",
            "averageWaitingTimeInSeconds": 521
        },
        {
            "_id": null,
            "averageWaitingTimeInSeconds": 1216
        }
    ],
    "count": 3,
    "offset": 0,
    "total": 3,
    "success": true
}

Last updated

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