Get Chat Status of Agents

Retrieves the status of chats per agent for a specific time duration.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/analytics/dashboards/charts/chats-per-agent

Permission required: view-livechat-manager

Query Parameters

KeyExample ValueDescription

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/charts/chats-per-agent?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

{
    "test.cat": {
        "open": 1,
        "closed": 4
    },
    "kim.jane": {
        "open": 1,
        "closed": 3
    },
    "lee.keith": {
        "open": 0,
        "closed": 4
    },
    "success": true
}

Last updated

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