ダッシュボードウィジェットデータを取得

ボットに追加された特定のカスタムダッシュボードから、ウィジェットのデータ結果を取得します。

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

On this Page

Get Dashboard Widget Data

To get the data result of a widget from a specific Custom Dashboard added to a bot.

To use this API, app needs the Bot Builder API scope of Custom Reports.

GET https://{{host}}/api/public/bot/{{BotID}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1

Path Parameters

Parameter	Required/Optional	Description
host	Required	Environment URL, for example, https://bots.kore.ai
BotID	Required	Bot ID or Stream ID. You can access it from the General Settings page of the bot.
dashboardName	Required	Name of the Custom Dashboard containing the required Widget.
widgetName	Required	Name of the Widget whose data needs to be retrieved.
limit	Optional	The number of records to fetch. The maximum applicable limit is 50.
startDate	Optional	The start date from which you want to see the changes. If unspecified, the date is automatically set to the bot creation date. Enter the date in ISO date format. For example, March 30, 1998 would be 1998-03-30.
endDate	Optional	The end date up to which you want to see the changes. Enter the date in ISO date format. For example, March 30, 1998 would be 1998-03-30.

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/public/bot/{{bot_id}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}} \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \

Sample Response

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

On this Page