{"id":5202,"date":"2022-07-08T11:10:27","date_gmt":"2022-07-08T05:40:27","guid":{"rendered":"https:\/\/docs.kore.ai\/smartassist\/?p=5202"},"modified":"2022-07-08T11:10:27","modified_gmt":"2022-07-08T05:40:27","slug":"get-agents-in-a-agent-group-based-on-source","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/agentassist\/get-agents-in-a-agent-group-based-on-source\/","title":{"rendered":"Get agents in a agent group based on source"},"content":{"rendered":"

<\/span>Overview<\/span><\/h2>\n

This method is used to fetch the agents in an agent group based on the source.
\n<\/span>(TBD)<\/span><\/p>\n

<\/span>Request<\/span><\/h2>\n

This section describes the information that is available in the request.<\/p>\n\n\n\n\n
Method<\/b><\/th>\nURL<\/th>\nEnd Point<\/th>\n<\/tr>\n
\n
GET<\/pre>\n<\/td>\n
<\/td>\n\n
\/public\/{streamId}\/analytics\/manager\/agents\/summary<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/span>Request Parameters<\/span><\/h3>\n
<\/span>Path Parameters<\/span><\/h4>\n\n\n\n\n
Parameter<\/b><\/th>\nRequired<\/b><\/th>\nDescription<\/b><\/th>\nType\/Value<\/b><\/th>\n<\/tr>\n
streamId *<\/td>\n\u00a0Y<\/td>\nStream ID
\n(e.g. <\/span>\u00a0st-606c43de5e00ca5f4e27e38a)<\/span><\/td>\n		String<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/span>Query Parameters<\/span><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired<\/b><\/th>\nDescription<\/b><\/th>\nType\/Value<\/b><\/th>\n<\/tr>\n
agentGroupIds[]<\/td>\n\u00a0N<\/td>\nAgent group ids<\/td>\narray[string]<\/td>\n<\/tr>\n
source<\/td>\n\u00a0N<\/td>\n\n
\n
Conversation source type (chat or call or both)
\nAvailable values<\/i>\u00a0: chat, call<\/span><\/p>\n<\/div>\n<\/td>\n
String<\/td>\n<\/tr>\n
sortBy<\/td>\n\u00a0N<\/td>\nSort by query in the form of field:desc\/asc (for e.g., name:asc)<\/td>\nString<\/td>\n<\/tr>\n
fromTime\u00a0*<\/td>\n\u00a0Y<\/td>\n\n
\n
Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z)<\/p>\n<\/div>\n<\/td>\n
Date<\/td>\n<\/tr>\n
toTime\u00a0*<\/td>\n\u00a0Y<\/td>\n\n
\n
Date in ISO81 format (for e.g. 2021-03-31T12:01:00.000Z)<\/p>\n<\/div>\n<\/td>\n
Date<\/td>\n<\/tr>\n
limit<\/td>\n\u00a0N<\/td>\n\n
\n
\n
Maximum number of Agent groups
\nDefault value<\/i>\u00a0: 10<\/span><\/p>\n<\/div>\n<\/div>\n<\/td>\n
Integer<\/td>\n<\/tr>\n
page<\/td>\n\u00a0N<\/td>\n\n
\n
\n
Page number
\nDefault value<\/i>\u00a0: 1<\/span><\/p>\n<\/div>\n<\/div>\n<\/td>\n
Integer<\/td>\n<\/tr>\n
status[]<\/td>\nN<\/td>\n\n
\n
Status of agent<\/p>\n<\/div>\n<\/td>\n
array[string]<\/td>\n<\/tr>\n
subStatus[]<\/td>\nN<\/td>\n\n
\n
subStatus of agent<\/p>\n<\/div>\n<\/td>\n
array[string]<\/td>\n<\/tr>\n
channels[]<\/td>\nN<\/td>\n\n
\n
Channel source<\/p>\n<\/div>\n<\/td>\n
array[string]<\/td>\n<\/tr>\n
skillGroupIds[]<\/td>\nN<\/td>\n\n
\n
skill group ids<\/p>\n<\/div>\n<\/td>\n
array[string]<\/td>\n<\/tr>\n
skillIds[]<\/td>\nN<\/td>\nlist of skill ids<\/td>\narray[string]<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/span>Sample Request<\/span><\/h3>\n
TBD<\/pre>\n
<\/span>Response<\/span><\/span><\/h3>\n
The following table describes the information that is available in the response.<\/p>\n
<\/span>Response Fields<\/span><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
<\/td>\n<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n[\/vc_column_text]
<\/div><\/div>
<\/span>Authorization<\/span><\/h3>\n
Invoke the API with JWT in the header with the following syntax:<\/span><\/p>\n
auth: {{JWT}}<\/span><\/pre>\n
<\/span>Response Content Type<\/span><\/h3>\n
application\/json<\/code><\/p>\n<\/div><\/div>
<\/div><\/div>
<\/span>Sample Response<\/span><\/h3>\n
{\n  \"results\"<\/span>: [\n    {\n      \"firstName\"<\/span>: \"Amanda\",\n      \"lastName\"<\/span>: \"Jones\",\n      \"nickName\"<\/span>: \"Amanda\",\n      \"status\"<\/span>: \"available\",\n      \"stats\"<\/span>: {\n        \"resolved\"<\/span>: 1,\n        \"completed\"<\/span>: 1,\n        \"transferred\"<\/span>: 1,\n        \"dropOff\"<\/span>: 1,\n        \"total\"<\/span>: 3\n      },\n      \"realtime\"<\/span>: {\n        \"active\"<\/span>: 1,\n        \"idle\"<\/span>: 1,\n        \"overdue\"<\/span>: 1,\n        \"terminated\"<\/span>: 1\n      },\n      \"time\"<\/span>: {\n        \"resolution\"<\/span>: 1,\n        \"firstResponse\"<\/span>: 1\n      },\n      \"customers\"<\/span>: {\n        \"active\"<\/span>: 1,\n        \"queue\"<\/span>: 1\n      },\n      \"loadPercentage\"<\/span>: 75\n    }\n  ],\n  \"page\"<\/span>: 1,\n  \"limit\"<\/span>: 10,\n  \"hasMore\"<\/span>: true,\n  \"totalPages\"<\/span>: 1,\n  \"totalResults\"<\/span>: 1\n}<\/code><\/pre>\n<\/div><\/div>
<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
Overview This method is used to fetch the agents in an agent group based on the source. (TBD) Request This section describes the information that is available in the request. Method URL End Point GET \/public\/{streamId}\/analytics\/manager\/agents\/summary Request Parameters Path Parameters Parameter Required Description Type\/Value streamId * \u00a0Y Stream ID (e.g. \u00a0st-606c43de5e00ca5f4e27e38a) String Query Parameters Parameter…<\/p>\n","protected":false},"author":23,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts\/5202"}],"collection":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/users\/23"}],"replies":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/comments?post=5202"}],"version-history":[{"count":0,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts\/5202\/revisions"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/media?parent=5202"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/categories?post=5202"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/tags?post=5202"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}