Get Agents count based on status

Overview

This method is used to obtain the agents’ count based on statuses.

Request

This section describes the information that is available in the request.

Method	URL	End Point
GET		/public/{streamId}/analytics/manager/agents/status

Request Parameters

Path Parameters

Parameter	Required	Description	Type/Value
streamId *	Y	Stream ID (e.g. st-606c43de5e00ca5f4e27e38a)	String

Query Parameters

Parameter	Required	Description	Type/Value
agentGroupIds[]	N	Agent group ids	array[string]
source	N	Conversation source type (chat or call or both) Available values : chat, call	String
fromTime *	Y	Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z)	Date
toTime *	Y	Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z)	Date

Sample Request

TBD

Response

The following table describea the information that is available in the response.

Response Fields

Parameter	Required/Optional	Description

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Response

{
  "total": 11,
  "statuses": [
    {
      "isActive": true,
      "label": "Available",
      "value": "AVAILABLE",
      "color": "#4FFF33",
      "count": 4
    },
    {
      "isActive": true,
      "label": "Busy",
      "value": "BUSY",
      "color": "#FF5733",
      "count": 1
    },
    {
      "isActive": true,
      "label": "Offline",
      "value": "OFFLINE",
      "color": "#D5D8DC",
      "count": 3
    },
    {
      "isActive": true,
      "label": "Away",
      "value": "AWAY",
      "color": "#F4D03F",
      "count": 3,
      "subStatusCounts": {
        "label": "lunch break",
        "count": 2
      }
    }
  ],
  "channels": [
    {
      "count": 1,
      "channel": "rtm"
    }
  ]
}