봇에 추가된 특정 맞춤형 대시보드에서 위젯의 데이터 결과를 가져옵니다.
이 API를 사용하려면 맞춤형 보고서의 봇 빌더 API 범위가 필요합니다.
GET https://{{host}}/api/public/bot/{{BotID}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1
경로 매개 변수
| 매개 변수 | 필수/선택 사항 | 설명 |
|---|---|---|
| host | 필수 | 환경 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"
}
]
}
}
ボットに追加された特定のカスタムダッシュボードから、ウィジェットのデータ結果を取得します。
この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" } ] } }
Leave a Reply
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"
}
]
}
}