To extract the metrics data related to the intent detection and task performance using API. It can be used to retrieve metrics information related to 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 |
|
| API Scope |
|
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| BotID | Required | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
Sample Request
curl --location --request POST 'https://bots.kore.ai/api/public/bot/st-xxxxxxd-xxxx-xxxx-xxxx-xxxxxxxxxx/getAnalytics' \
--header 'auth: eyJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'content-type: application/json' \
--data-raw '{
"type": "unhandledutterance",
"filters": {
"from": "2022-09-11T17:25:09.698Z",
"to": "2022-09-25T17:25:09.698Z",
"channel": [
"rtm"
],
"isAmbiguous": false,
"isDeveloper": false,
"trained": false,
"userId": [
"u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
]
},
"sort":
{ "order": "asc",
"by": "nodeName" },
"limit": 50
}'
Body Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| type | Required |
The type of metrics requested can be:
|
| filters | Required | Object with the following details to filter the result set |
| from | Required | The start timestamp from which the records need to be considered. |
| to | Required | The end timestamp from which the records need to be considered. |
| limit | Required | Number of records to be fetched. |
| channel | Optional | The channels to be considered for the metrics. |
| channelUIds | Optional | The user ids (channel specified) to be included in the metrics. |
| isAmbiguous | Optional | whether to include ambiguous intents or not – set to true or false |
| isDeveloper | Optional | whether to include developer metrics – set to true or false. |
| trained | Optional | whether to include trained intents or not – set to true or false. |
| taskId | Optional | To filter based on the task ids. |
| userId | Optional | To filter based on user id. |
| tags | Optional | To filter based on custom tags. Usage: "tags": {
"and": [
{
"name": "user",
"values": ["uservalue"],
"type": "user"
},
{
"name": "message",
"values": ["mvalue"],
"type": "message"
}
]
}
|
| sort | Optional | To sort the results. Usage: "sort":
{ "order": "<desc/asc>",
"by": "<column name>" }
|
| skip | Optional | Number of records to be skipped from the result set. |
Sample Response
{
"moreAvailable": false,
"result": [
{
"_id": "63xxxxxxxxxxxxxxxxx",
"messageId": "ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"sessionId": "63xxxxxxxxxxxxxxx",
"utterance": "aslfkj",
"intent": "Mobile Enquiry",
"userId": "u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"channelUId": "test@abc.xyz",
"language": "en",
"timestamp": "2022-09-24T08:24:39.840Z",
"pinned": false,
"channel": "rtm",
"winningIntent": [],
"isAmbiguous": false,
"ambiguousIntents": [],
"taskName": "Mobile Enquiry",
"flow": [],
"taskId": "dg-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"koralogstatusId": "f-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxxxxx",
"customTags": {
"userTags": [
{
"name": "Name",
"value": "John"
}
],
"sessionTags": [],
"messageTags": []
},
"NLAnalysis": {
"result": "unhandledUtterance",
"messageStoreId": "ms-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"channelId": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:rtm",
"bot": "Channel Check",
"botid": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"skipConversation": true,
"task": "Mobile Enquiry",
"botLanguage": "en-US",
"nluLanguage": "en-US",
"taskId": "dg-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"fields": {},
"logSequenceId": "f-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx-xxxxxxxxxx",
"intentStatus": "published",
"subType": "dialog",
"channelInfo": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:u-xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:rtm",
"input": [
"aslfkj"
],
"taskContextId": "dcx-xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"NLAnalysis": {
"intentRescoring": true,
"isPreferDefinitiveMatch": true,
"scoringModel": "original",
"toneAnalysis": {},
"nlProcessing": {
"originalInput": "aslfkj",
"spellCorrectedInput": null,
"canonical": "Aslak",
"wordAnalysis": [
{
"index": 1,
"word": "Aslak",
"ignored": false,
"pos": "Noun_proper_singular ",
"role": "MAINSUBJECT ",
"original": "aslfkj",
"processedWord": "Aslak"
}
]
},
"ml": {
"intentModel": "bot level intent model",
"eliminated": [
{
"task": "Book Appointment",
"state": "published",
"score": 0.017055602351504544,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
},
{
"task": "Transfer Money",
"state": "published",
"score": 0.011911144983740555,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
},
{
"task": "Show Balance",
"state": "published",
"score": 0.009209086809082547,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
}
],
"namedEntityRecognition": []
},
"faq": {
"demystify": {
"lemmatizer_used": "PATTERN",
"normalizedQuery": "aslfkj",
"OntologyTraits": [],
"failed_questions": {},
"SelectedPathCount": 3,
"ExtractedEntities": [],
"ContextEntities": [],
"PreConditionNodes": [],
"filtered_questions": {
"score": [],
"traits": []
}
}
}
},
"language": "en",
"channel": "rtm",
"userId": "u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"time": "2022-09-24T08:24:39.808Z",
"channelclient": "botbuilder",
"_id": "f-121d2486-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxxxx",
"resourceid": "korastatuslogs",
"entityOrgId": "o-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"iv": "VP47awbZ8JRCoqFtgPx7fA==",
"cek": {
"header": {
"alg": "dir",
"enc": "aes-256-cbc",
"kid": "k-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
}
},
"ire": true
},
"nodeName": "Entity_color",
"promptType": "entity"
},
{
"_id": "63xxxxxxxxxxxx",
"messageId": "ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"sessionId": "63xxxxxxxxxxxxxxxxx",
"utterance": "alskd",
"intent": "Mobile Enquiry",
"userId": "u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"channelUId": "ramakrishnakoretest@getnada.com",
"language": "en",
"timestamp": "2022-09-24T08:24:50.257Z",
"pinned": false,
"channel": "rtm",
"winningIntent": [],
"isAmbiguous": false,
"ambiguousIntents": [],
"taskName": "Mobile Enquiry",
"flow": [],
"taskId": "dg-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"koralogstatusId": "f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx-xxxxxxx",
"customTags": {
"userTags": [
{
"name": "Name",
"value": "Krishna"
}
],
"sessionTags": [],
"messageTags": []
},
"NLAnalysis": {
"result": "unhandledUtterance",
"messageStoreId": "ms-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"channelId": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx:u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx:rtm",
"bot": "Channel Check",
"botid": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"skipConversation": true,
"task": "Mobile Enquiry",
"botLanguage": "en-US",
"nluLanguage": "en-US",
"taskId": "dg-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"fields": {},
"logSequenceId": "f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx-xxxxxxx",
"intentStatus": "published",
"subType": "dialog",
"channelInfo": "st-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx:u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:rtm",
"input": [
"alskd"
],
"taskContextId": "dcx-b3e58798-ed3b-5f3d-9894-2e26758001eb",
"NLAnalysis": {
"intentRescoring": true,
"isPreferDefinitiveMatch": true,
"scoringModel": "original",
"toneAnalysis": {},
"nlProcessing": {
"originalInput": "alskd",
"spellCorrectedInput": null,
"canonical": "alskd",
"wordAnalysis": [
{
"index": 1,
"word": "unknown-word",
"ignored": false,
"pos": "Noun_infinitive Noun_singular Verb_infinitive Verb_present Adjective_normal Adverb ",
"original": "alskd",
"processedWord": "alskd"
}
]
},
"ml": {
"intentModel": "bot level intent model",
"eliminated": [
{
"task": "Book Appointment",
"state": "published",
"score": 0.017055602351504544,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
},
{
"task": "Transfer Money",
"state": "published",
"score": 0.011911144983740555,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
},
{
"task": "Show Balance",
"state": "published",
"score": 0.009209086809082547,
"scoringCriteria": "Probabilistic score",
"matchType": "unlikely"
}
],
"namedEntityRecognition": []
},
"faq": {
"demystify": {
"lemmatizer_used": "PATTERN",
"normalizedQuery": "alskd",
"OntologyTraits": [],
"failed_questions": {},
"SelectedPathCount": 3,
"ExtractedEntities": [],
"ContextEntities": [],
"PreConditionNodes": [],
"filtered_questions": {
"score": [],
"traits": []
}
}
}
},
"language": "en",
"channel": "rtm",
"userId": "u-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"time": "2022-09-24T08:24:50.226Z",
"channelclient": "botbuilder",
"_id": "f-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx-xxxxxxxx",
"resourceid": "korastatuslogs",
"entityOrgId": "o-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"iv": "+Kl5i6AAFJp0g3NkExn+Og==",
"cek": {
"header": {
"alg": "dir",
"enc": "aes-256-cbc",
"kid": "k-xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx"
}
},
"ire": true
},
"nodeName": "Entity_capacity",
"promptType": "entity"
}
],
"totalCount": 2
}