{"id":4973,"date":"2022-07-14T13:39:12","date_gmt":"2022-07-14T08:09:12","guid":{"rendered":"https:\/\/docs.kore.ai\/smartassist\/?p=4973"},"modified":"2022-07-14T13:39:12","modified_gmt":"2022-07-14T08:09:12","slug":"get-agent-desktop-conversations-stats","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/agentassist\/get-agent-desktop-conversations-stats\/","title":{"rendered":"Get Agent Desktop Conversations Stats"},"content":{"rendered":"

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

This method is used to fetch the statuses of Agent Desktop Conversations.<\/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
GET<\/td>\n<\/td>\n\/public\/{streamId}\/analytics\/conversations\/stats<\/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><\/h3>\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
startDate\u00a0*<\/td>\n\u00a0Y<\/td>\nDate in ISO81 format<\/td>\nDate<\/td>\n<\/tr>\n
endDate *<\/td>\n\u00a0Y<\/td>\nDate in ISO81 format<\/td>\nDate<\/td>\n<\/tr>\n
compareStartDate<\/td>\n\u00a0N<\/td>\nDate in ISO81 format<\/td>\nDate<\/td>\n<\/tr>\n
compareEndDate<\/td>\n\u00a0N<\/td>\nDate in ISO81 format<\/td>\nDate<\/td>\n<\/tr>\n
agentGroupIds[]<\/td>\n\u00a0N<\/td>\nAgent group ids<\/td>\nString<\/td>\n<\/tr>\n
agentIds[]<\/td>\n\u00a0N<\/td>\nList of user ids<\/td>\nString<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/span>Sample Request<\/span><\/h3>\n
TBD<\/pre>\n[\/vc_column_text]
<\/div><\/div>
<\/span>Response<\/span><\/span><\/h2>\n
The following table describes the information that is available in the response.<\/p>\n
<\/p>\n<\/div><\/div>
<\/span><\/p>\n
<\/span>Response Fields<\/span><\/h3>\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<\/div><\/div>
<\/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
{<\/span>\n\n\"active\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"call\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"recentlyClosed\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"call\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"idle\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"abandoned\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"call\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"deflection\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"callback\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"call\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n},<\/span>\n\n\"callbackOpted\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10,<\/span>\n\n\"call\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"chat\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n},<\/span>\n\n\"email\": {<\/span>\n\n\"total\": 10,<\/span>\n\n\"previous\": 10,<\/span>\n\n\"percentageChange\": 10<\/span>\n\n}<\/span>\n\n}<\/span>\n\n}<\/span><\/pre>\n<\/div><\/div>
<\/div><\/div>[\/vc_column][\/vc_row]\n","protected":false},"excerpt":{"rendered":"
Overview This method is used to fetch the statuses of Agent Desktop Conversations. Request This section describes the information that is available in the request Method URL End Point GET \/public\/{streamId}\/analytics\/conversations\/stats Request Parameters Path Parameters Parameter Required Description Type\/Value streamId * \u00a0Y Stream ID (e.g. \u00a0st-606c43de5e00ca5f4e27e38a) String Query Parameters Parameter Required Description Type\/Value startDate\u00a0* \u00a0Y…<\/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\/4973"}],"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=4973"}],"version-history":[{"count":0,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts\/4973\/revisions"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/media?parent=4973"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/categories?post=4973"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/tags?post=4973"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}