API Guide

To configuring the Botkit Url, App, and events. To use this API, app needs the Bot Builder API scope of BotKit. PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it from the General Settings page of the…

To configuring the Botkit Url, App, and events. To use this API, app needs the Bot Builder API scope of BotKit. PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it from the General Settings page of the…

Used to get data from Table View. To use this API, the app needs to be given Read access to the Table View from the Data Definition in DaaS (see here for details) POST https://{{host}}/api/public/views/{{viewName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai viewName The table view form…

Used to get data from Data Table. To use this API, the app needs to be given Read access to the Data Table from the Data Definition in DaaS (see here for details) POST https://{{host}}/api/public/tables/{{tableName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai tableName Name of the Table…

Used to delete data from Data Table. To use this API, the app needs to be given Read and Delete access to the Data Table from the Data Definition in DaaS (see here for details) DELETE https://{{host}}/api/public/tables/{{tableName}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai tableName Name of…

Used to update data into Data Table. To use this API, the app needs to be given Read and Write access to the Data Table from the Data Definition in DaaS (see here for details) PUT https://{{host}}/api/public/tables/{{tableName}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai tableName Name of…

Used to insert data into Data Table. To use this API, the app needs to be given Write access to the Data Table from the Data Definition in DaaS (see here for details) POST https://{{host}}/api/public/tables/{{tableName}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai tableName Name of the table…

To get admin console audit logs. To use this API, app needs the Admin API Scope. GET https://{{host}}/api/public/auditlogs?size=50&offset=0&fromDate={{timestamp}}&toDate={{timestamp}}&fetchAfter={{AuditLogId}} NOTE: This feature was introduced in ver7.2 of the platform. Query Parameters   Parameter Description host Environment URL, for example, https://bots.kore.ai size Number of records to be fetched upto a maximum of…

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…

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…