Docs

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…

koreUtil Libraries

koreUtil libraries provide pre-written JavaScript functions which makes common or complex tasks easy to implement. These libraries often target specific tasks such as setting up recurring rules for calendar, parsing and manipulation of dates, conversion of dates between timezone, tools to simplify programming with strings, numbers, arrays, functions and objects…

Adding the Workplace by Facebook Channel

This channel enablement flow is modified as per the changes implemented by Facebook post v7.2 of the product. To add the Workplace by Facebook channel to your bot, you need a developer portal Facebook account to configure the connection between Facebook Workplace and Kore.ai. Kore.ai application must be authorized to send…

How to Create Custom Dashboard

In this How-To, we will explore a scenario in a Banking Bot, where, various metrics will be used to analyze the bot performance and track some trends for business needs. For details on what Custom Dashboards are and how they are implemented in the Kore.ai Bots platform, refer here. Problem…

Remove Users from Account

To remove users from an account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. DELETE https://{{host}}/api/public/users NOTE: This feature was introduced in ver7.1 of the platform. Query…

Bots Platform v7.0

This section contains major and minor release information for the Kore.ai Bots Platform v7.0 released on June 15, 2019. This release includes features that help enhance the user experience by enabling intent detection based on Traits and Context Management, event transition based on Sentiment Analysis. Many features have been improved…

Update User API

To update user details. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. PUT https://{{host}}/api/public/users NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters Parameter…

Create User API

To add users to an account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. POST https://{{host}}/api/public/users NOTE: This feature was introduced in ver7.1 of the platform. Query…

Get User Information

To retrieve the user details. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. POST https://{{host}}/api/public/usersInfo NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters…

Delete Customer Data Status API

Used to get the status of the Customer Data Delete request. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics. GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId NOTE: This feature was introduced in ver7.1…