{"id":5190,"date":"2022-07-08T12:07:27","date_gmt":"2022-07-08T06:37:27","guid":{"rendered":"https:\/\/docs.kore.ai\/smartassist\/?p=5190"},"modified":"2022-07-08T12:07:27","modified_gmt":"2022-07-08T06:37:27","slug":"get-csat-conversation-summary-by-agents","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/agentassist\/get-csat-conversation-summary-by-agents\/","title":{"rendered":"Get CSAT conversation summary by agents"},"content":{"rendered":"<h2><span class=\"ez-toc-section\" id=\"Overview\"><\/span>Overview<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p><span style=\"font-weight: 400\">This method is used to obtain the CSAT conversation summary based on agents.<br \/>\n<\/span><span style=\"font-weight: 400\">(TBD)<\/span><\/p>\n<h2><span class=\"ez-toc-section\" id=\"Request\"><\/span>Request<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>This section describes the information that is available in the request.<\/p>\n<table>\n<tbody>\n<tr>\n<th><b>Method<\/b><\/th>\n<th>URL<\/th>\n<th>End Point<\/th>\n<\/tr>\n<tr>\n<td>\n<pre>GET<\/pre>\n<\/td>\n<td><\/td>\n<td>\n<pre>\/public\/{streamId}\/analytics\/csat\/agents\/summary<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3><span class=\"ez-toc-section\" id=\"Request_Parameters\"><\/span>Request Parameters<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<h4><span class=\"ez-toc-section\" id=\"Path_Parameters\"><\/span>Path Parameters<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<table>\n<tbody>\n<tr>\n<th><b>Parameter<\/b><\/th>\n<th><b>Required<\/b><\/th>\n<th><b>Description<\/b><\/th>\n<th><b>Type\/Value<\/b><\/th>\n<\/tr>\n<tr>\n<td>streamId *<\/td>\n<td>\u00a0Y<\/td>\n<td>Stream ID<br \/>\n<span style=\"font-weight: 400\">(e.g. <\/span><span style=\"font-weight: 400\">\u00a0st-606c43de5e00ca5f4e27e38a)<\/span><\/td>\n<td>String<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4><span class=\"ez-toc-section\" id=\"Query_Parameters\"><\/span>Query Parameters<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<table>\n<tbody>\n<tr>\n<th><b>Parameter<\/b><\/th>\n<th><b>Required<\/b><\/th>\n<th><b>Description<\/b><\/th>\n<th><b>Type\/Value<\/b><\/th>\n<\/tr>\n<tr>\n<td>startDate\u00a0*<\/td>\n<td>\u00a0Y<\/td>\n<td>Date in ISO81 format<br \/>\n(e.g.. 2021-03-31T12:01:00.000Z)<\/td>\n<td>Date<\/td>\n<\/tr>\n<tr>\n<td>endDate *<\/td>\n<td>\u00a0Y<\/td>\n<td>Date in ISO81 format<\/td>\n<td>Date<\/td>\n<\/tr>\n<tr>\n<td>agentGroupIds[]<\/td>\n<td>\u00a0N<\/td>\n<td>Agent group ids<\/td>\n<td>array[string]<\/td>\n<\/tr>\n<tr>\n<td>agentIds[]<\/td>\n<td>\u00a0N<\/td>\n<td>List of user ids<\/td>\n<td>array[string]<\/td>\n<\/tr>\n<tr>\n<td>sortBy<\/td>\n<td>\u00a0N<\/td>\n<td>sort by query in the form of field:desc\/asc (for e.g., name:asc)<\/td>\n<td>String<\/td>\n<\/tr>\n<tr>\n<td>limit<\/td>\n<td>\u00a0N<\/td>\n<td>\n<div class=\"renderedMarkdown\">\n<p>Maximum limit of records<br \/>\n<i style=\"font-family: inherit;font-size: inherit\">Default value<\/i><span style=\"font-family: inherit;font-size: inherit\">\u00a0: 10<\/span><\/p>\n<\/div>\n<\/td>\n<td>Integer<\/td>\n<\/tr>\n<tr>\n<td>offset<\/td>\n<td>\u00a0N<\/td>\n<td>\n<div class=\"renderedMarkdown\">\n<p>offset number<br \/>\n<i style=\"font-family: inherit;font-size: inherit\">Default value<\/i><span style=\"font-family: inherit;font-size: inherit\"> : 0<\/span><\/p>\n<\/div>\n<\/td>\n<td>Integer<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3><span class=\"ez-toc-section\" id=\"Sample_Request\"><\/span>Sample Request<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<pre>TBD<\/pre>\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h2><span class=\"ez-toc-section\" id=\"Response\"><\/span><span style=\"color: #26344a;font-size: 16px;letter-spacing: 0em\">Response<\/span><span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>The following table describes the information that is available in the response.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Response_Fields\"><\/span>Response Fields<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<table>\n<tbody>\n<tr>\n<th><b>Parameter<\/b><\/th>\n<th><b>Required\/Optional<\/b><\/th>\n<th><b>Description<\/b><\/th>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h3><span class=\"ez-toc-section\" id=\"Authorization\"><\/span>Authorization<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p><span style=\"font-weight: 400\">Invoke the API with JWT in the header with the following syntax:<\/span><\/p>\n<pre><span style=\"font-weight: 400\">auth: {{JWT}}<\/span><\/pre>\n<h3><span class=\"ez-toc-section\" id=\"Response_Content_Type\"><\/span>Response Content Type<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p><code>application\/json<\/code><\/p>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h3><span class=\"ez-toc-section\" id=\"Sample_Response\"><\/span>Sample Response<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<pre class=\"example microlight\"><code>{\n  <span class=\"hljs-attr\">\"results\"<\/span>: [\n    {\n      <span class=\"hljs-attr\">\"firstName\"<\/span>: \"first name\",\n      <span class=\"hljs-attr\">\"lastName\"<\/span>: \"last name\",\n      <span class=\"hljs-attr\">\"profImage\"<\/span>: \"http:\/\/example.com\/x.png\",\n      <span class=\"hljs-attr\">\"userId\"<\/span>: \"u-afds-asdf-adf\",\n      <span class=\"hljs-attr\">\"verySatisfied\"<\/span>: 10,\n      <span class=\"hljs-attr\">\"satisfied\"<\/span>: 20,\n      <span class=\"hljs-attr\">\"neutral\"<\/span>: 30,\n      <span class=\"hljs-attr\">\"dissatisfied\"<\/span>: 20,\n      <span class=\"hljs-attr\">\"veryDissatisfied\"<\/span>: 20\n    }\n  ],\n  <span class=\"hljs-attr\">\"offset\"<\/span>: 1,\n  <span class=\"hljs-attr\">\"limit\"<\/span>: 10,\n  <span class=\"hljs-attr\">\"hasMore\"<\/span>: false\n}<\/code><\/pre>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Overview This method is used to obtain the CSAT conversation summary based on agents. (TBD) Request This section describes the information that is available in the request. Method URL End Point GET \/public\/{streamId}\/analytics\/csat\/agents\/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&#8230;<\/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\/5190"}],"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=5190"}],"version-history":[{"count":0,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/posts\/5190\/revisions"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/media?parent=5190"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/categories?post=5190"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/agentassist\/wp-json\/wp\/v2\/tags?post=5190"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}