Debug Logs API

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

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

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

クエリパラメータ

パラメータ	説明
host	環境URL、例： `https://bots.kore.ai`
version	APIのバージョンをご覧ください。このAPIの現在のバージョンは「1.1」です。
BotID	ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。
identity	呼び出しに関連付けられた固有の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/1.1/{{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: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