{"id":5181,"date":"2022-07-14T15:26:38","date_gmt":"2022-07-14T09:56:38","guid":{"rendered":"https:\/\/docs.kore.ai\/smartassist\/?p=5181"},"modified":"2022-07-14T15:26:38","modified_gmt":"2022-07-14T09:56:38","slug":"get-conversation-summary","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/agentassist\/get-conversation-summary\/","title":{"rendered":"Get conversation summary"},"content":{"rendered":"

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

This method is used to obtain the conversation summary.
\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\/conversations\/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
Parameter<\/b><\/th>\nRequired<\/b><\/th>\nDescription<\/b><\/th>\nType\/Value<\/b><\/th>\n<\/tr>\n
source<\/td>\nN<\/td>\nConversation source – chat or call<\/span><\/td>\nString<\/td>\n<\/tr>\n
startDate\u00a0*<\/td>\n\u00a0Y<\/td>\nDate in ISO81 format
\n(e.g.. 2021-03-31T12:01:00.000Z)<\/td>\n		Date<\/td>\n<\/tr>\n
endDate *<\/td>\n\u00a0Y<\/td>\nDate in ISO81 format<\/td>\nDate<\/td>\n<\/tr>\n
agentGroupIds[]<\/td>\n\u00a0N<\/td>\nAgent group ids<\/td>\narray[string]<\/td>\n<\/tr>\n
agentIds[]<\/td>\n\u00a0N<\/td>\nList of user ids<\/td>\narray[string]<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/span>Sample Request<\/span><\/h3>\n
TBD<\/pre>\n
<\/div><\/div>
<\/span>Response<\/span><\/span><\/h2>\n
The following table describes the information that is available in the response.<\/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
{\n  \"resolved\"<\/span>: 10,\n  \"unResolved\"<\/span>: 20,\n  \"transferred\"<\/span>: 30,\n  \"dropOff\"<\/span>: 20\n}<\/code><\/pre>\n<\/div><\/div>
<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
Overview This method is used to obtain the conversation summary. (TBD) Request This section describes the information that is available in the request. Method URL End Point GET \/public\/{streamId}\/analytics\/conversations\/summary 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 source N Conversation source…<\/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\/5181"}],"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=5181"}],"version-history":[{"count":0,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts\/5181\/revisions"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/media?parent=5181"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/categories?post=5181"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/tags?post=5181"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}