get-conversations-by-status.md

Get Conversations by Status

View the metrics of omnichannel conversations in your workspace during a selected time range based on their status: Open, Queued, On Hold, or Closed

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/analytics/dashboards/conversations-by-status	yes

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

Query Parameters

Key	Example Value	Description
start*	2023-11-28T00:11:22.345Z	The start time.
end*	2023-11-29T00:11:22.345Z	The end time.

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/priorities\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-id'

Example Response

{
    "total": 25,
    "data": [
        {
            "label": "Closed",
            "value": 24
        },
        {
            "label": "Open",
            "value": 1
        },
        {
            "label": "Queued",
            "value": 0
        },
        {
            "label": "On_Hold",
            "value": 0
        }
    ],
    "success": true
}

Change Log

Version	Description
6.4.0	Added