API Guide

Data Update API

  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…

Data Insert API

  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…

Get Admin Console Audit Logs API

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…

Get Dashboard Widget Data

To retrieve the data associated with custom widgets and the reports of a bot. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/dashboard/ {{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit={{limit}}Note: A POST API call is now supported to include the additional filters for querying the data. See Custom Dashboard Filters to know more about additional filters. Content Type application/json Authorization auth:…

Remove Users from Account

To remove users from an account. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method DELETE Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

Update User API

To update the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method PUT Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

Create User API

To add users to an account. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot…

Get User Information

To retrieve the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/usersInfo Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

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 the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method GET Endpoint https://{{host}}/api/public/bot/eraseUsersData/status/:reqId Content Type application/json Authorization auth: {{JWT}} See How to generate…

Delete Customer Data API

This API is used to delete customer data. Note: Delete User will not proceed if the requested user is: An account owner or belongs to one or more accounts. The bot owner or co-developer for one or more bots. Method DELETE Endpoint https://{{host}}/api/public/bot/eraseUsersData Content Type application/json Authorization auth: {{JWT}} See…
Menu