ボットに追加された特定のカスタムダッシュボードから、ウィジェットのデータ結果を取得します。
このAPIを使用するために、アプリは [カスタムレポート] の [ボットビルダーのAPIスコープ] を必要とします。
GET https://{{host}}/api/public/bot/{{BotID}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1
パスパラメータ
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| ホスト | 必須 | 環境URL（例： https://bots.kore.ai） |
| BotID | 必須 | ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 |
| dashboardName | 必須 | 必要なウィジェットを含むカスタムダッシュボードの名前です。 |
| widgetName | 必須 | データを取得する必要のあるウィジェットの名前です。 |
| limit | オプション | 取得する記録の数です。最大値は50です。 |
| startDate | オプション | 変更内容を確認する日付の開始日です。指定されていない場合、日付は自動的にボットの作成日に設定されます。ISOの日付形式で日付を入力します。例えば、1998年3月30日は1998-03-30となります。 |
| endDate | オプション | 変更内容を確認する日付の終了日です。ISOの日付形式で日付を入力します。例えば、1998年3月30日は1998-03-30となります。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X GET \ https://{{host}}/api/public/bot/{{bot_id}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}} \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \
サンプル応答
{ "_id": "wg-xxxx-xxx-xxx-xxx-xxxxx", "overlay": [], "name": "dasaDSA", "type": "table", "sqlQuery": { "dataSet": "Analytics", "select": "metricType", "startDate": "2019-08-31T18:30:00.000Z", "endDate": "2019-10-01T18:30:00.000Z", "botId": "st-xxxxx-xxx-xxx-xxx-xxxxx" }, "dimensions": [ { "fieldName": "metricType", "displayName": "metricType", "type": "string" } ], "metrics": [], "row": [], "properties": {}, "queryResponse": { "metaData": { "metricType": "string" }, "queryResponse": [ { "metricType": "successintents" }, { "metricType": "successtasks" }, { "metricType": "successintents" }, { "metricType": "successintents" }, { "metricType": "successtasks" }, { "metricType": "failedintents" } ] } }