{"id":24916,"date":"2020-10-31T08:40:26","date_gmt":"2020-10-31T08:40:26","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=24916"},"modified":"2024-03-20T14:45:14","modified_gmt":"2024-03-20T14:45:14","slug":"get-analytics-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/get-analytics-api\/","title":{"rendered":"Get Analytics API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

The Get Analytics API allows you to retrieve metrics data related to intent detection and task performance. The API provides information about various metrics, including Intents Found, Intents not Found, Unhandled Utterances, Failed Tasks, Successful Tasks, and Performance Logs.<\/span><\/p>\n\n\n\n\n\n\n\n
Method<\/strong><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/getAnalytics<\/code><\/td>\n<\/tr>\n
Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: Metrics<\/li>\n
  • Admin Console: Not Applicable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
    BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

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

    The following sample request shows how to retrieve <\/span>unhandled utterance<\/span><\/i> analytics data with specific filters. You can modify the <\/span>type<\/span><\/i> and <\/span>filters<\/span><\/i> parameters to retrieve different types of analytics data as needed.<\/span><\/p>\n

    curl --location --request POST 'https:\/\/bots.kore.ai\/api\/public\/bot\/st-xxxxxxd-xxxx-xxxx-xxxx-xxxxxxxxxx\/getAnalytics' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data-raw '{\r\n    \"type\": \"unhandledutterance\",\r\n    \"filters\": {\r\n        \"from\": \"2022-09-11T17:25:09.698Z\",\r\n        \"to\": \"2022-09-25T17:25:09.698Z\",\r\n       \r\n           \r\n        \"channel\": [\r\n            \"rtm\"\r\n        ],\r\n        \"isAmbiguous\": false,\r\n        \"isDeveloper\": false,\r\n        \"trained\": false,\r\n        \"userId\": [\r\n            \"u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\"\r\n        ]\r\n       \r\n       \r\n    },\r\n    \"sort\":\r\n        { \"order\": \"asc\",\r\n          \"by\": \"nodeName\" },\r\n   \r\n    \"limit\": 50\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Request Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nType<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    type<\/span><\/td>\nstring, required<\/span><\/td>\nIndicates the type of metrics for which you can retrieve data:<\/span><\/p>\n
      \n
    • successintent<\/li>\n
    • failintent<\/li>\n
    • successtask<\/li>\n
    • failtask<\/li>\n
    • performance<\/li>\n
    • unhandledutterance<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    filters<\/span><\/td>\nobject, required<\/span><\/td>\nA set of filters to narrow down the analytics data.<\/span><\/td>\n<\/tr>\n
    filters.from<\/span><\/td>\nstring, required<\/span><\/td>\nThe start timestamp for the data retrieval.<\/span><\/td>\n<\/tr>\n
    filters.to<\/span><\/td>\nstring, required<\/span><\/td>\nThe end timestamp for the data retrieval.<\/span><\/td>\n<\/tr>\n
    <\/td>\n<\/td>\n<\/td>\n<\/tr>\n
    filters.channel<\/span><\/td>\narray of strings, optional<\/span><\/td>\nAn array containing channel names to filter data by; the default channel is \u201crtm\u201d.<\/span><\/p>\n
    Accepted channels are:<\/span><\/p>\n
      \n
    • \u201cskypeforbusiness\u201d<\/span><\/li>\n
    • \u201cmsteams\u201d<\/span><\/li>\n
    • \u201ctwitter\u201d<\/span><\/li>\n
    • \u201cspark\u201d<\/span><\/li>\n
    • \u201crtm\u201d<\/span><\/li>\n
    • \u201cfacebook\u201d<\/span><\/li>\n
    • \u201cslack\u201d<\/span><\/li>\n
    • \u201cskype\u201d<\/span><\/li>\n
    • \u201ckore\u201d<\/span><\/li>\n
    • \u201cemail\u201d<\/span><\/li>\n
    • \u201csms\u201d<\/span><\/li>\n
    • \u201cfacebook\u201d<\/span><\/li>\n
    • \u201cringcentral\u201d<\/span><\/li>\n
    • \u201cjabber\u201d<\/span><\/li>\n
    • \u201cyammer\u201d<\/span><\/li>\n
    • \u201calexa\u201d<\/span><\/li>\n
    • \u201ctwiliovoice\u201d<\/span><\/li>\n
    • \u201ctelegram\u201d<\/span><\/li>\n
    • \u201civr\u201d<\/span><\/li>\n
    • \u201civrVoice\u201d<\/span><\/li>\n
    • \u201csmartassist\u201d<\/span><\/li>\n
    • \u201cline\u201d<\/span><\/li>\n
    • \u201cliveperson\u201d<\/span><\/li>\n
    • \u201cgoogleactions\u201d<\/span><\/li>\n
    • \u201changoutchat\u201d<\/span><\/li>\n
    • \u201cmattermost\u201d<\/span><\/li>\n
    • \u201crcs\u201d<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    filters.channel.channelUIds<\/span><\/td>\narray of strings, optional<\/span><\/td>\nThe end-user\u2019s identity provided by the channel.<\/span><\/p>\n
    Note<\/strong>: For “ivr” channel, it’s a combination of <\/span>{accountId}\/{channel}\/{channelUId}<\/code>.
    \nFor example,
    \n\"channelUIds\": [\"5fb6a04e20ab9d2c19cb73xx\/ivrinst-893b4d4f-1fc1-54c3-b3xx-fa7200c4c2xx\/first.last@domain.com\"]<\/code><\/td>\n<\/tr>\n
    filters.isAmbiguous<\/span><\/td>\nboolean, optional<\/span><\/td>\nWhether to include ambiguous intents or not \u2013 set to <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    filters.isDeveloper<\/span><\/td>\nboolean, optional<\/span><\/td>\nWhether to include developer metrics \u2013 set to <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    filters.trained<\/span><\/td>\nboolean, optional<\/span><\/td>\nWhether to include trained intents or not \u2013 set to <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    filter.taskId<\/span><\/td>\narray of strings, optional<\/span><\/td>\nTo filter based on the task IDs.<\/span><\/td>\n<\/tr>\n
    filters.userId<\/span><\/td>\narray of strings, optional<\/span><\/td>\nTo filter based on user IDs.<\/span><\/td>\n<\/tr>\n
    filters.tags<\/span><\/td>\nobject, optional<\/span><\/td>\nMeta tags to filter the records.<\/span>
    \nUsage example:<\/p>\n
    \"tags\": {\r\n         \"and\": [\r\n                 {\r\n                  \"name\": \"user\",\r\n                  \"values\": [\"uservalue\"],\r\n                  \"type\": \"user\"\r\n                  },\r\n                  {\r\n                   \"name\": \"message\",\r\n                   \"values\": [\"mvalue\"],\r\n                   \"type\": \"message\"\r\n                   }\r\n                ]\r\n           }<\/pre>\n<\/td>\n<\/tr>\n
    sort<\/td>\nobject, optional<\/span><\/td>\nAn object containing the sorting criteria to apply to the data being retrieved:<\/span><\/p>\n
      \n
    • order (string, required)<\/span><\/i>: Sorting order, either “asc” for ascending or “desc” for descending.<\/span><\/li>\n
    • by<\/span><\/i> (string, required)<\/span><\/i>: The field\/column by which the data should be sorted. <\/span><\/li>\n<\/ul>\n
      Usage example:<\/p>\n
      \"sort\": \r\n       { \"order\": \"<desc\/asc>\", \r\n          \"by\": \"<column name>\" }<\/pre>\n<\/td>\n<\/tr>\n
    limit<\/span><\/td>\ninteger, required<\/span><\/td>\nIndicates the number of records to be returned in the result set.<\/span><\/td>\n<\/tr>\n
    skip<\/td>\ninteger, required<\/span><\/td>\nThe number of records to be skipped from the result set.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    {\r\n    \"moreAvailable\": false,\r\n    \"result\": [\r\n        {\r\n            \"_id\": \"63xxxxxxxxxxxxxxxxx\",\r\n            \"messageId\": \"ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\r\n            \"sessionId\": \"63xxxxxxxxxxxxxxx\",\r\n            \"utterance\": \"aslfkj\",\r\n            \"intent\": \"Mobile Enquiry\",\r\n            \"userId\": \"u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\r\n            \"channelUId\": \"test@abc.xyz\",\r\n            \"language\": \"en\",\r\n            \"timestamp\": \"2022-09-24T08:24:39.840Z\",\r\n            \"pinned\": false,\r\n            \"channel\": \"rtm\",\r\n            \"winningIntent\": [],\r\n            \"isAmbiguous\": false,\r\n            \"ambiguousIntents\": [],\r\n            \"taskName\": \"Mobile Enquiry\",\r\n            \"flow\": [],\r\n            \"taskId\": \"dg-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n            \"koralogstatusId\": \"f-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxxxxx\",\r\n            \"customTags\": {\r\n                \"userTags\": [\r\n                    {\r\n                        \"name\": \"Name\",\r\n                        \"value\": \"John\"\r\n                    }\r\n                ],\r\n                \"sessionTags\": [],\r\n                \"messageTags\": []\r\n            },\r\n            \"NLAnalysis\": {\r\n                \"result\": \"unhandledUtterance\",\r\n                \"messageStoreId\": \"ms-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\",\r\n                \"channelId\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:rtm\",\r\n                \"bot\": \"Channel Check\",\r\n                \"botid\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\",\r\n                \"skipConversation\": true,\r\n                \"task\": \"Mobile Enquiry\",\r\n                \"botLanguage\": \"en-US\",\r\n                \"nluLanguage\": \"en-US\",\r\n                \"taskId\": \"dg-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\",\r\n                \"fields\": {},\r\n                \"logSequenceId\": \"f-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx-xxxxxxxxxx\",\r\n                \"intentStatus\": \"published\",\r\n                \"subType\": \"dialog\",\r\n                \"channelInfo\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:u-xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:rtm\",\r\n                \"input\": [\r\n                    \"aslfkj\"\r\n                ],\r\n                \"taskContextId\": \"dcx-xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n                \"NLAnalysis\": {\r\n                    \"intentRescoring\": true,\r\n                    \"isPreferDefinitiveMatch\": true,\r\n                    \"scoringModel\": \"original\",\r\n                    \"toneAnalysis\": {},\r\n                    \"nlProcessing\": {\r\n                        \"originalInput\": \"aslfkj\",\r\n                        \"spellCorrectedInput\": null,\r\n                        \"canonical\": \"Aslak\",\r\n                        \"wordAnalysis\": [\r\n                            {\r\n                                \"index\": 1,\r\n                                \"word\": \"Aslak\",\r\n                                \"ignored\": false,\r\n                                \"pos\": \"Noun_proper_singular \",\r\n                                \"role\": \"MAINSUBJECT \",\r\n                                \"original\": \"aslfkj\",\r\n                                \"processedWord\": \"Aslak\"\r\n                            }\r\n                        ]\r\n                    },\r\n                    \"ml\": {\r\n                        \"intentModel\": \"bot level intent model\",\r\n                        \"eliminated\": [\r\n                            {\r\n                                \"task\": \"Book Appointment\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.017055602351504544,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            },\r\n                            {\r\n                                \"task\": \"Transfer Money\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.011911144983740555,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            },\r\n                            {\r\n                                \"task\": \"Show Balance\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.009209086809082547,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            }\r\n                        ],\r\n                        \"namedEntityRecognition\": []\r\n                    },\r\n                    \"faq\": {\r\n                        \"demystify\": {\r\n                            \"lemmatizer_used\": \"PATTERN\",\r\n                            \"normalizedQuery\": \"aslfkj\",\r\n                            \"OntologyTraits\": [],\r\n                            \"failed_questions\": {},\r\n                            \"SelectedPathCount\": 3,\r\n                            \"ExtractedEntities\": [],\r\n                            \"ContextEntities\": [],\r\n                            \"PreConditionNodes\": [],\r\n                            \"filtered_questions\": {\r\n                                \"score\": [],\r\n                                \"traits\": []\r\n                            }\r\n                        }\r\n                    }\r\n                },\r\n                \"language\": \"en\",\r\n                \"channel\": \"rtm\",\r\n                \"userId\": \"u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n                \"time\": \"2022-09-24T08:24:39.808Z\",\r\n                \"channelclient\": \"botbuilder\",\r\n                \"_id\": \"f-121d2486-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxxxx\",\r\n                \"resourceid\": \"korastatuslogs\",\r\n                \"entityOrgId\": \"o-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\r\n                \"iv\": \"VP47awbZ8JRCoqFtgPx7fA==\",\r\n                \"cek\": {\r\n                    \"header\": {\r\n                        \"alg\": \"dir\",\r\n                        \"enc\": \"aes-256-cbc\",\r\n                        \"kid\": \"k-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\"\r\n                    }\r\n                },\r\n                \"ire\": true\r\n            },\r\n            \"nodeName\": \"Entity_color\",\r\n            \"promptType\": \"entity\"\r\n        },\r\n        {\r\n            \"_id\": \"63xxxxxxxxxxxx\",\r\n            \"messageId\": \"ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\r\n            \"sessionId\": \"63xxxxxxxxxxxxxxxxx\",\r\n            \"utterance\": \"alskd\",\r\n            \"intent\": \"Mobile Enquiry\",\r\n            \"userId\": \"u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\",\r\n            \"channelUId\": \"ramakrishnakoretest@getnada.com\",\r\n            \"language\": \"en\",\r\n            \"timestamp\": \"2022-09-24T08:24:50.257Z\",\r\n            \"pinned\": false,\r\n            \"channel\": \"rtm\",\r\n            \"winningIntent\": [],\r\n            \"isAmbiguous\": false,\r\n            \"ambiguousIntents\": [],\r\n            \"taskName\": \"Mobile Enquiry\",\r\n            \"flow\": [],\r\n            \"taskId\": \"dg-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n            \"koralogstatusId\": \"f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx-xxxxxxx\",\r\n            \"customTags\": {\r\n                \"userTags\": [\r\n                    {\r\n                        \"name\": \"Name\",\r\n                        \"value\": \"Krishna\"\r\n                    }\r\n                ],\r\n                \"sessionTags\": [],\r\n                \"messageTags\": []\r\n            },\r\n            \"NLAnalysis\": {\r\n                \"result\": \"unhandledUtterance\",\r\n                \"messageStoreId\": \"ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx\",\r\n                \"channelId\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx:u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx:rtm\",\r\n                \"bot\": \"Channel Check\",\r\n                \"botid\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n                \"skipConversation\": true,\r\n                \"task\": \"Mobile Enquiry\",\r\n                \"botLanguage\": \"en-US\",\r\n                \"nluLanguage\": \"en-US\",\r\n                \"taskId\": \"dg-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\",\r\n                \"fields\": {},\r\n                \"logSequenceId\": \"f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx-xxxxxxx\",\r\n                \"intentStatus\": \"published\",\r\n                \"subType\": \"dialog\",\r\n                \"channelInfo\": \"st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:rtm\",\r\n                \"input\": [\r\n                    \"alskd\"\r\n                ],\r\n                \"taskContextId\": \"dcx-b3e58798-ed3b-5f3d-9894-2e26758001eb\",\r\n                \"NLAnalysis\": {\r\n                    \"intentRescoring\": true,\r\n                    \"isPreferDefinitiveMatch\": true,\r\n                    \"scoringModel\": \"original\",\r\n                    \"toneAnalysis\": {},\r\n                    \"nlProcessing\": {\r\n                        \"originalInput\": \"alskd\",\r\n                        \"spellCorrectedInput\": null,\r\n                        \"canonical\": \"alskd\",\r\n                        \"wordAnalysis\": [\r\n                            {\r\n                                \"index\": 1,\r\n                                \"word\": \"unknown-word\",\r\n                                \"ignored\": false,\r\n                                \"pos\": \"Noun_infinitive Noun_singular Verb_infinitive Verb_present Adjective_normal Adverb \",\r\n                                \"original\": \"alskd\",\r\n                                \"processedWord\": \"alskd\"\r\n                            }\r\n                        ]\r\n                    },\r\n                    \"ml\": {\r\n                        \"intentModel\": \"bot level intent model\",\r\n                        \"eliminated\": [\r\n                            {\r\n                                \"task\": \"Book Appointment\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.017055602351504544,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            },\r\n                            {\r\n                                \"task\": \"Transfer Money\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.011911144983740555,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            },\r\n                            {\r\n                                \"task\": \"Show Balance\",\r\n                                \"state\": \"published\",\r\n                                \"score\": 0.009209086809082547,\r\n                                \"scoringCriteria\": \"Probabilistic score\",\r\n                                \"matchType\": \"unlikely\"\r\n                            }\r\n                        ],\r\n                        \"namedEntityRecognition\": []\r\n                    },\r\n                    \"faq\": {\r\n                        \"demystify\": {\r\n                            \"lemmatizer_used\": \"PATTERN\",\r\n                            \"normalizedQuery\": \"alskd\",\r\n                            \"OntologyTraits\": [],\r\n                            \"failed_questions\": {},\r\n                            \"SelectedPathCount\": 3,\r\n                            \"ExtractedEntities\": [],\r\n                            \"ContextEntities\": [],\r\n                            \"PreConditionNodes\": [],\r\n                            \"filtered_questions\": {\r\n                                \"score\": [],\r\n                                \"traits\": []\r\n                            }\r\n                        }\r\n                    }\r\n                },\r\n                \"language\": \"en\",\r\n                \"channel\": \"rtm\",\r\n                \"userId\": \"u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx\",\r\n                \"time\": \"2022-09-24T08:24:50.226Z\",\r\n                \"channelclient\": \"botbuilder\",\r\n                \"_id\": \"f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxx\",\r\n                \"resourceid\": \"korastatuslogs\",\r\n                \"entityOrgId\": \"o-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx\",\r\n                \"iv\": \"+Kl5i6AAFJp0g3NkExn+Og==\",\r\n                \"cek\": {\r\n                    \"header\": {\r\n                        \"alg\": \"dir\",\r\n                        \"enc\": \"aes-256-cbc\",\r\n                        \"kid\": \"k-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx\"\r\n                    }\r\n                },\r\n                \"ire\": true\r\n            },\r\n            \"nodeName\": \"Entity_capacity\",\r\n            \"promptType\": \"entity\"\r\n        }\r\n    ],\r\n    \"totalCount\": 2\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>
    \r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Response Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    PARAMETER<\/b><\/td>\nDESCRIPTION<\/b><\/td>\n<\/tr>\n
    moreAvailable<\/span><\/td>\nIndicates if the API has returned all the records or if more are available, based on the pagination criteria.<\/span><\/p>\n
    True<\/b> if more records are available. <\/span>False<\/b> if there are no more records to be retrieved.<\/span><\/td>\n<\/tr>\n
    result<\/span><\/td>\nContains complete information about the metrics.<\/span><\/td>\n<\/tr>\n
    id<\/span><\/td>\nThe unique identifier for the record.<\/span><\/td>\n<\/tr>\n
    messagesId<\/span><\/td>\nThe unique identifier for the message record.<\/span><\/td>\n<\/tr>\n
    sessionId<\/span><\/td>\nThe unique identifier for the session.<\/span><\/td>\n<\/tr>\n
    utterance<\/span><\/td>\nThe user utterance\/input.<\/span><\/td>\n<\/tr>\n
    intent<\/span><\/td>\nThe identified intent for the user’s utterance\/input.<\/span><\/td>\n<\/tr>\n
    userId<\/span><\/td>\nThe unique identifier for the user<\/span>.<\/span><\/td>\n<\/tr>\n
    channelUId<\/span><\/td>\nThe end-user\u2019s identity provided by the channel. It can be the user\u2019s email ID or enterprise-assigned unique ID.<\/span><\/td>\n<\/tr>\n
    language<\/span><\/td>\nThe language in which the conversation happened with the bot.<\/span><\/td>\n<\/tr>\n
    timestamp<\/span><\/td>\nThe response date is converted into timestamp format.<\/span><\/td>\n<\/tr>\n
    pinned<\/span><\/td>\nIndicates whether the message is pinned – <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    channel<\/span><\/td>\nName of the channel through which the conversation occurred.<\/span><\/td>\n<\/tr>\n
    winningIntent<\/span><\/td>\nAn array containing the winning intent(s) for the utterance.<\/span><\/td>\n<\/tr>\n
    isAmbiguous<\/span><\/td>\nIndicates whether the intent is ambiguous – <\/span>true<\/span><\/i> or <\/span>false.<\/span><\/i><\/td>\n<\/tr>\n
    ambiguousIntents<\/span><\/td>\nAn array of ambiguous intents, if applicable.<\/span><\/td>\n<\/tr>\n
    taskName<\/span><\/td>\nThe name of the task associated with the conversation.<\/span><\/td>\n<\/tr>\n
    nodeName<\/span><\/td>\nThe node name. This parameter is retrieved only for the <\/span>Performance<\/span><\/i> metric.<\/span><\/td>\n<\/tr>\n
    type<\/span><\/td>\nThe type of the node. This parameter is retrieved only for the <\/span>Performance<\/span><\/i> metric.<\/span><\/td>\n<\/tr>\n
    status<\/span><\/td>\nThe status of the task. This parameter is retrieved only for the <\/span>Performance<\/span><\/i> metric.<\/span><\/td>\n<\/tr>\n
    statusCode<\/span><\/td>\nThe status code of the task. This parameter is retrieved only for the <\/span>Performance<\/span><\/i> metric.<\/span><\/td>\n<\/tr>\n
    responseTime<\/span><\/td>\nThe response time for the task. This parameter is retrieved only for the <\/span>Performance<\/span><\/i> metric.<\/span><\/td>\n<\/tr>\n
    flow<\/span><\/td>\nAn array of task flows.<\/span><\/td>\n<\/tr>\n
    taskId<\/span><\/td>\nThe unique identifier for the task.<\/span><\/td>\n<\/tr>\n
    koralogstatusId<\/span><\/td>\nThe unique identifier for the koralog status.<\/span><\/td>\n<\/tr>\n
    customTags<\/span><\/td>\nCustom tags added to the user’s profile.<\/span><\/td>\n<\/tr>\n
    customTags.userTags<\/span><\/td>\nUser tags added to the user\u2019s profile information.<\/span><\/td>\n<\/tr>\n
    userTags.name<\/span><\/td>\nTag\u2019s name.<\/span><\/td>\n<\/tr>\n
    userTags.value<\/span><\/td>\nTag\u2019s value.<\/span><\/td>\n<\/tr>\n
    customTags.sessionTags<\/span><\/td>\nCustom tags added to the conversation session<\/span>.<\/span><\/td>\n<\/tr>\n
    customTags.messagesTags<\/span><\/td>\nMeta tags to filter the conversations.<\/span><\/td>\n<\/tr>\n
    NLAnalysis<\/span><\/td>\nContains natural language analysis results, including intent recognition and other natural language processing details.<\/span><\/p>\n
    The \u2018NLAnalysis\u2019 object includes multiple sub-objects such as \u2018intentRescoring\u2019, \u2018nlProcessing\u2019, \u2018ml\u2019 (machine learning analysis), \u2018fm\u2019 (fundamental meaning analysis), \u2018faq\u2019 (frequently asked questions analysis), and finalResolver. Each of these sub-objects contains information related to the analysis process, such as linguistic analysis, intent recognition, and the elimination of unlikely intents, etc.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.debugTitle<\/span><\/td>\nThe metric type in the NL Analysis. Possible values are:<\/span><\/p>\n
      \n
    • Intent Match Successful<\/span><\/li>\n
    • Intent Match Failed<\/span><\/li>\n
    • Intent Failed\/Abandoned<\/span><\/li>\n
    • Intent Completed Successfully<\/span><\/li>\n
    • Unhandled Utterances<\/span><\/li>\n
    • Performance<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    NLAnalysis.result<\/span><\/td>\nThe result of the NL analysis. For example, the result can be an unhandled utterance or a failed task.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.messageStoreId<\/span><\/td>\nA unique identifier for the message stored in the system.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.channelId<\/span><\/td>\nThe identifier for the channel where the conversation took place.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.bot<\/span><\/td>\nThe name of the bot that handled the conversation.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.botid<\/span><\/td>\nThe unique identifier for the bot.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.skipConversation<\/span><\/td>\nIf set to true, skips the conversation record. If false, do not skip the conversation.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.task<\/span><\/td>\nThe name of the task associated with the conversation.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.botLanguage<\/span><\/td>\nThe language used by the bot.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nluLanguage<\/span><\/td>\nThe language in which the NLP training happened for that particular bot language.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.taskId<\/span><\/td>\nThe unique identifier for the task associated with the conversation.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.isDeveloper<\/span><\/td>\nWhether the session was initiated by a developer –\u00a0 <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.reason<\/span><\/td>\nThe NL analysis reason object.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/td>\n<\/tr>\n
    NLAnalysis.reason.cause<\/span><\/td>\nThe cause for NL analysis failure. For example, the script node failure.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.reason.causeId<\/span><\/td>\nThe NL analysis cause id.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.fields<\/span><\/td>\nThe fields; Contains additional fields associated with the interaction.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.logSequenceId<\/span><\/td>\nThe unique log sequence identifier.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.intentStatus<\/span><\/td>\nThe status of the intent.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.subType<\/span><\/td>\nThe task subtype.\u00a0 For example, a dialog.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.channelInfo<\/span><\/td>\nThe bot channel information.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.input<\/span><\/td>\nAn array containing the user’s input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.taskContextId<\/span><\/td>\nThe unique task context identifier.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.intentRescoring<\/span><\/td>\nIndicates whether intent rescoring was enabled – <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>. (<\/span>true<\/span><\/i> means the system may reevaluate and rescore intents during the processing of the user’s input.)<\/span><\/td>\n<\/tr>\n
    NLAnalysis.isPreferDefinitiveMatch<\/span><\/td>\nIndicates whether the system prefers a definitive match when recognizing intents – <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.scoringModel<\/span><\/td>\nThe scoring model used for intent recognition. Possible value – <\/span>original<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.toneAnalysis<\/span><\/td>\nThe toneAnalysis object; Contains the tone analysis of the task. <\/span>Learn more<\/span><\/a>.<\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing<\/span><\/td>\nThe nlProcessing object; Contains information about the linguistic analysis and natural language processing of the user’s input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.originalInput<\/span><\/td>\nThe original user input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.spellCorrectedInput<\/span><\/td>\nIf spelling correction is applied, it would contain the corrected user input. (Null indicates no spelling correction applied.)<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.canonical<\/span><\/td>\nThe canonical representation of the input; typically represents a normalized or recognized form of the user’s input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis<\/span><\/td>\nAn array of objects, each containing a detailed analysis of individual words in the user’s input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.index<\/span><\/td>\nThe position of the word in the input.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.word<\/span><\/td>\nThe recognized\/analyzed word.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.ignored<\/span><\/td>\nIndicates whether the word was ignored in the analysis – <\/span>true<\/span><\/i> or <\/span>false<\/span><\/i>.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.pos<\/span><\/td>\nPart-of-speech tagging for the word.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.role<\/span><\/td>\nThe role or function of the word in the context.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.original<\/span><\/td>\nThe original word.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.nlProcessing.wordAnalysis.processedWord<\/span><\/td>\nThe processed word.<\/span><\/td>\n<\/tr>\n
    NLAnalysis.ml<\/span><\/td>\nThe ml object; Contains information related to machine learning analysis, including intent recognition and elimination of unlikely intents. (Most of the parameters\/values returned by the object are used internally.)<\/span><\/td>\n<\/tr>\n
    NLAnalysis.fm<\/span><\/td>\nThe fm object; Contains information related to fundamental meaning analysis, provides insights into the scoring, matching, and elimination of tasks, etc. (Most of the parameters\/values returned by the object are used internally.)\u00a0\u00a0\u00a0<\/span><\/td>\n<\/tr>\n
    NLAnalysis.faq<\/span><\/td>\nThe faq object; Contains detailed information about the analysis of user input related to faq. (Most of the parameters\/values returned by the object are used internally.)\u00a0\u00a0<\/span><\/td>\n<\/tr>\n
    NLAnalysis.finalResolver<\/span><\/td>\nThe finalResolver object; Contains information related to the final resolution process and the determination of the response or action to be taken based on the user’s input. (Most of the parameters\/values returned by the object are used internally.)<\/span><\/td>\n<\/tr>\n
    totalCount<\/span><\/td>\nThe total number of records identified as per the API request parameters.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"The Get Analytics API allows you to retrieve metrics data related to intent detection and task performance. The API provides information about various metrics, including Intents Found, Intents not Found, Unhandled Utterances, Failed Tasks, Successful Tasks, and Performance Logs. Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/getAnalytics Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-24916","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24916","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=24916"}],"version-history":[{"count":21,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24916\/revisions"}],"predecessor-version":[{"id":61546,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24916\/revisions\/61546"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=24916"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=24916"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=24916"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}