Skip to main content
Back to API List

​
Queue Size

To get the queueDetails by giving queueId and filters with the given streamId.
MethodPOST
Endpointhttps://{host}/agentassist/api/v1/public/{{streamId}}/monitor/queueStatsById/{{queueId}}
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token
API ScopeSmartAssist Analytics

​
Query Parameters

ParameterDescriptionType
hostThe Environment URL. For example, https://platform.kore.aistring, required
queueIdYou can get the queueId in the /queues GET API.string, required
streamIdbotId or streamId. You can get it from the App Settings page.string, required

​
Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/monitor/queueStatsById/{{queueId}}/' \
--header 'auth: <token>' \
--header 'accountId: {{accountId}}' \
--header 'Content-Type: application/json' \
--data '{
"languages": ["en", "es"],
"channels": ["rtm", "msteams"]
}'

​
Header Parameters

HeaderDescriptionOptional/Required
accountidUnique account identifier.Required
authJWT authentication token.Required
content-typeRequest body format (application/json;charset=UTF-8)Required

​
Request Parameters

ParameterDescriptionRequired/OptionalType
ChannelsTo filter the results based on the channel. Select from the following: rtm, ivr, sms, slack, facebook, kore, spark, msteams, twitter, telegram, wfacebook, ringcentral, jabber, yammer, whatsapp, line, liveperson, mattermost, wechat, web-sdk, rcs, unblu, audiocodes, alexa, twiliovoice, ivrVoice, korevg, email, emailConnect, rtm : Web/Mobile Client channel, ivr : agent ai channeloptionalarray of strings
LanguagesTo filter the results based on the bot language, that’s, interaction language with the bot. Only Contact Center AI supported languages can be selected and should be selected from the following: en, de, es, fr, pt, it, zh_cn, zh_tw, id, ko, nl, ja, ar, fi, ru, pl, uk, sv, kk[ nb : Norwegian, hi : Hindi, te : Telugu, ta : Tamil, mr : Marathi, ca : Catalan, sl : Slovenian, ge : Georgia]optionalarray of strings

​
Sample Response

[
    {
        "queueId": "qu-aa16c29-08b2-4948-aa00-a6a3547exxxx",
        "queueName": "Default Queue",
        "skills": [],
        "waiting": 0,
        "engaged": 0,
        "dropOff": 44,
        "agentStatus": {
            "available": 1,
            "offline": 0,
            "busy": 0,
            "away": 0
        },
        "noOfAgents": 1,
        "queueSummary": {
            "avgWait": 0,
            "maxWait": 0,
            "ASA": 0  // ASA - Average Speed to Answer
        }
    }
]