To get debug logs of a specific conversation (currently supported only for IVR Channel).
To use this API, app needs the Bot Builder API scope of Debug Logs.
GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}}
Query Parameters
Parameter | Description |
---|---|
host | Environment URL, for example, https://bots.kore.ai |
version | Refers to the version of the API. The current version of this API is “1.1” |
BotID | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
identity | Unique ID associated with the call. |
channelType | “ivrVoice” currently supported channel |
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 |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
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}}' \
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" } } ]