{"id":22977,"date":"2019-12-10T10:01:52","date_gmt":"2019-12-10T10:01:52","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=22977"},"modified":"2021-03-25T09:03:14","modified_gmt":"2021-03-25T09:03:14","slug":"get-widget","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/get-widget\/","title":{"rendered":"Get Dashboard Widget Data"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To get the data result of a widget from a specific Custom Dashboard added to a bot.<\/p>\n

To use this API, app needs the Bot Builder API scope of Custom Reports<\/em>.<\/p>\n

GET <\/b>https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/dashboard\/{{dashboardName}}\/widget\/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Path Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n
dashboardName<\/td>\nRequired<\/td>\nName of the Custom Dashboard containing the required Widget.<\/td>\n<\/tr>\n
widgetName<\/td>\nRequired<\/td>\nName of the Widget whose data needs to be retrieved.<\/td>\n<\/tr>\n
limit<\/td>\nOptional<\/td>\nThe number of records to fetch. The maximum applicable limit is 50.<\/td>\n<\/tr>\n
startDate<\/td>\nOptional<\/td>\nThe 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,\u00a0March 30, 1998 would be 1998-03-30.<\/td>\n<\/tr>\n
endDate<\/td>\nOptional<\/td>\nThe end date up to which you want to see the changes.\u00a0Enter the date in ISO date format. For example,\u00a0March 30, 1998 would be 1998-03-30.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X GET \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{bot_id}}\/dashboard\/{{dashboardName}}\/widget\/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}} \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"_id\": \"wg-xxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"overlay\": [],\r\n    \"name\": \"dasaDSA\",\r\n    \"type\": \"table\",\r\n    \"sqlQuery\": {\r\n        \"dataSet\": \"Analytics\",\r\n        \"select\": \"metricType\",\r\n        \"startDate\": \"2019-08-31T18:30:00.000Z\",\r\n        \"endDate\": \"2019-10-01T18:30:00.000Z\",\r\n        \"botId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\"\r\n    },\r\n    \"dimensions\": [\r\n           {\r\n            \"fieldName\": \"metricType\",\r\n            \"displayName\": \"metricType\",\r\n            \"type\": \"string\"\r\n        }\r\n    ],\r\n    \"metrics\": [],\r\n    \"row\": [],\r\n    \"properties\": {},\r\n    \"queryResponse\": {\r\n        \"metaData\": {\r\n            \"metricType\": \"string\"\r\n        },\r\n        \"queryResponse\": [\r\n            {\r\n                \"metricType\": \"successintents\"\r\n            },\r\n            {\r\n                \"metricType\": \"successtasks\"\r\n            },\r\n            {\r\n                \"metricType\": \"successintents\"\r\n            },\r\n            {\r\n                \"metricType\": \"successintents\"\r\n            },\r\n            {\r\n                \"metricType\": \"successtasks\"\r\n            },\r\n            {\r\n                \"metricType\": \"failedintents\"\r\n            }\r\n        ]\r\n    }\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-22977","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22977","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=22977"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22977\/revisions"}],"predecessor-version":[{"id":23418,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/22977\/revisions\/23418"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=22977"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=22977"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=22977"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}