デバッグログAPI

特定の会話のデバッグログを取得するには（現在はIVRチャネルのみサポート）。

このAPIを使用するために、アプリは [デバッグログ] の [ボットビルダーのAPIスコープ] を必要とします。

GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}}

クエリパラメータ

パラメータ	説明
ホスト	環境URL（例） `https://bots.kore.ai`
BotID	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
ID	呼び出しに関連付けられた一意のID。
channelType	"ivrVoice" 現在サポートされているチャネル
minimumInfo	任意のフィールドです。サマリのみを取得する場合は"true"を設定
offset	ログの取得を開始するページ番号を指定します。指定されていない場合は、ログのリストの最初のページである0から開始されます
limit	取得する記録の数です。最大値は50です
timezone	例：America/New_York
fromDate	ログがリクエストされた日付。有効なフォーマット（yyyy-mm-dd）または有効なタイムスタンプ
toDate	ログがリクエストされるまでの日付。有効なフォーマット（yyyy-mm-dd）または有効なタイムスタンプ

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ https://{{host}}/api/{{version}}/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

[ { "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:6: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:7:54.395Z", "debugTitle": "Company: Reached end of dialog", "debugLevel": "Info", "metaInfo": { "channel": "ivrVoice", "identity": "Nov22PilotEnv1" } } ]

On this Page

Debug Logs API

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"
        }
    }
]

On this Page