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 | Required | The start date from which you want to see the changes. Enter the date in ISO date format. For example, March 30, 2020 would be 2020-03-30. |
| endDate | Required | The end date up to which you want to see the changes. Enter the date in ISO date format. For example, March 30, 2020 would be 2020-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"
}
]
}
}