To fetch debug logs of a specific conversation.
| Method | GET |
| Endpoint | https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Path Parameters
| Parameter | Description |
|---|---|
| host | Environment URL, for example, https://bots.kore.ai |
| BotID | Bot ID. You can access it from the General Settings page of the bot. |
Sample Request
curl -X GET \
'https://{{host}}/api/1.1/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Body Parameters
| Parameter | Description |
|---|---|
| version | Refers to the version of the API. The current version of this API is “1.1” |
| identity | Unique ID associated with the call. |
| channel | Name of the channel through which the conversation is initiated. The default is ‘rtm’.
Accepted channel types are:
|
| minimumInfo | Optional field. Set to ‘true’ to get only the summary |
| offset | Specify the page number from which to start fetching the logs. If unspecified, it starts from 0, which is the first page of the list of logs |
| limit | The number of records to fetch. The maximum applicable limit is 50 |
| timezone | Ex: America/New_York |
| fromDate | Date from which the logs are requested, valid formats: yyyy-mm-dd or valid timestamp |
| toDate | Date up to which the logs are requested, valid formats: yyyy-mm-dd or valid timestamp |
Sample Response
[
{
"timestamp": "2018-11-22T13:06:17.258Z",
"nomatch_count": "0",
"noinput_count": "1",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node processing is completed",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "entity node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "Waiting for user input",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing",
"debugLevel": "info",
"timestamp": "2018-11-22T13:06:17.304Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing successful",
"debugLevel": "info",
"debugDetail": "\"Let me know your name\\n\"",
"timestamp": "2018-11-22T13:06:17.325Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:31.464Z",
"nomatch_count": "2",
"noinput_count": "0",
"debugTitle": "Nam",
"debugLevel": "Warning",
"debugMessage": "executeNode has invoked due to MAX_NO_MATCH event",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:07:54.395Z",
"debugTitle": "Company: Reached end of dialog",
"debugLevel": "Info",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
}
]