API Guide

To provide the number of users who have interacted with the bot in a given period across different time intervals. To use this API, the app needs the Bot Scope. POST https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream…

  Used to insert bulk data into Data Table. Method POST Endpoint https://{{host}}/api/public/tables/{{tableName}}/bulk Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Write access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the data…

This API is used to configure the Botkit Url, App, and events. Note: To use this API, app needs the XO Platform API scope of BotKit. Syntax: 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…

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. Method POST Endpoint https://{{host}}/api/public/views/{{viewName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Read access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the data in…

  Used to get data from Data Table. Method POST Endpoint https://{{host}}/api/public/tables/{{tableName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Read access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the data in…

  Used to delete data from Data Table. Method DELETE Endpoint https://{{host}}/api/public/tables/{{tableName}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Read and Delete access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the…

  Used to update data into Data Table. Method PUT Endpoint https://{{host}}/api/public/tables/{{tableName}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Read and Write access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the…

  Used to insert data into Data Table. Method POST Endpoint https://{{host}}/api/public/tables/{{tableName}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. App Access Write access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the data in…

To retrieve the audit logs from Bot Admin Console Note: This feature was introduced in ver7.2 of the platform. Method GET Endpoint https://{{host}}/api/public/auditlogs? size=50&offset=0&fromDate={{timestamp}}&toDate={{timestamp}}&fetchAfter={{AuditLogId}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Logs > Admin Console Audit…