Bot Insight API details
- Zuletzt aktualisiert2020/09/24
Bot Insight API details
To use the Bot Insight API, you have to send an HTTP request to the domain where the API is available.
The HTTP request is a Bot Insight API that is appended to the base URL
of the domain. For example: http://{DOMAIN
Name}:{Port}/v2/botinsight/data/api/{method}
. In this syntax, you have
to provide the domain name or its IP address, the mentioned URIs, and the Bot Insight method you want to call.
- The output of the Bot Insight APIs is paginated and fetches 1000 records at a time. You must use an offset to fetch the next set of records. Specify 0 as the offset to fetch data for the first 1000 records, 1 for the next 1000 records, and so on.
- Only UTF-8 English characters and numbers are supported. Hence, for the date field, you must use all-numeric date formats and not the language-specific characters.
Retrieving task variable profile
Description | Use this API to get information about the task variable profile. |
Method | GET |
Syntax |
http://{Host}:{Port}/v2/botinsight/data/api/gettaskvariableprofile/{JobName}?from=
${DateValue}&to=${DateValue}
|
Input parameters |
JobName: Name of the job for which you want to get the
data. From: The start date of the period for which you want to fetch the data. To: The end date of the period for which you want to fetch the data. The default date is the current date. |
Returns | Returns information about the variable profile in JSON format. |
Sample output |
|
User role | You must have the AAE_Bot Insight Admin role to
access the API. |
Retrieving task data
Description | Use this API to retrieve the analytics data that is logged for a task for a period of 90 days. |
Method | GET |
Syntax |
http://{Host}:{Port}/v2/botinsight/data/api/gettasklogdata/{task-name}/{page}/{from}/{to}?limit=
|
Input parameters |
task name: Name of the bot for which you
want to get the data. chunk: Page number from which you want to fetch the data. For example, you must specify 3 if you want to fetch data from page 4 that contains data of records from 4000 to 5000. from: The start date of the period for which you want to fetch the data. to: The end date of the period for which you want to fetch the data. The default date is the current date. limit: Specifies the number of parts in which the information is retrieved. The default limit is 1000. For example, if you specify the limit as 2500 to retrieve 10000 records, then: 0 chunk returns 1 - 2500 1st chunk returns 2501 - 5000 2nd chunk returns 5001 - 7500 3rd chunk returns 7501 - 10000 |
Returns | Returns the analytics data logged for the task in JSON format. |
Sample output |
|
User role | You must have the AAE_Bot Insight Admin role to
access the API. |
Retrieving bot run data
Description | Use this API to get information about the bot run data, such as on which server it ran and whether it ran successfully or encountered an error. |
Method | GET |
Syntax |
http://{Host}:{Port}/v2/botinsight/data/api/getbotrundata/{page}/{from}/{to}
|
Input parameters |
fromdate: The start date of the period for which you want to fetch the data. todate: The end date of the period for which you want to fetch the data. The default date is the current date. chunk: Specifies the number of parts in which the information is retrieved. The default limit is 1000. For example, if you specify the limit as 2500 to retrieve 10000 records, then: 0 chunk returns 1 - 2500 1st chunk returns 2501 - 5000 2nd chunk returns 5001 - 7500 3rd chunk returns 7501 - 10000 |
Returns | Returns the information about the bot run data in JSON format. |
Sample output |
|
User role | You must have the AAE_Bot Insight Admin or
AAE_Admin role to access the API. |
Retrieving audit trial data
Description | Use this API to get the audit data for all the users. |
Method | GET |
Syntax |
http://{Host}:{Port}/v2/botinsight/data/api/getaudittraildata/{page}/{FromDateValue}/
{EndDateValue}
|
Input parameters |
page: Page number from which you want to fetch the
data. from: The start date of the period for which you want to fetch the data. to: The end date of the period for which you want to fetch the data. The default date is the current date. |
Returns | Returns the information about the audit data of a user in JSON format. |
Sample output |
|
User role | You must have the AAE_Admin role to access the
API. |
Retrieving COE dashboard information
Description | Use this API to retrieve the COE dashboard information. |
Method | GET |
Header |
X-Authorization <<authentication
token>>
|
Syntax (without parameters) |
http://<host>:<port>/analytics/rest/api/coe_dashboard
|
Syntax (with parameters) |
http://<host>:<port>/analytics/rest/api/coe_dashboard?botname=ana&department=sample&username=runner&botrunnermachinename=ABL&units=per&limit=2&activitystatus=COMPLETED
|
Input parameters | There are no input parameters. |
Optional query parameters |
botname: Name of the bot. botrunnermachinename: Name of the Bot Runner machine. department: Name of the department. username: Name of the user. units: Specified unit. limit: The number of records to be retrieved.
activitystatus: Select the activity status
from the following list:
|
Returns | Returns the COE information in JSON format. |
Sample output |
|
User Role | Ensure that you have one of the following roles to access the
API:
|
Deleting business data
Description | Use this API to delete logged data from either the production mode or the development mode for a particular Control Roominstance. |
Method | DELETE |
Header |
X-Authorization <<authentication
token>>
|
Request format |
http://<host>:<port>/v2/botinsight/data/deletetasklogdata
|
Input parameters |
Node Name or Machine Name: Specifies the node name or the machine name. Bot ID: Specifies the public ID of the bot RunId: Specifies the ID that is generated by the bot. Mode: Specifies the mode: <DEV> or <PROD> From Date: Specifies the bot run start date. To Date: Specifies the bot run end date. Note: Log in as the
AAE_Bot Insight Admin user
to authorize the API. |
Returns | Returns the number of rows deleted along with the Bot ID. |
JSON object input |
|
Sample Response |
{ |
User role | You must have the AAE_Bot Insight Admin role to
access the API. |
Retrieving device schedule information
Description | Use this API to retrieve device-specific metrics. The API provides information about the number of times a device was scheduled and details of bots running on the device. |
Method | GET |
Header |
X-Authorization <<authentication
token>>
|
Request format (without parameters) |
http://<host>:<port>/v2/botinsight/data/api/getdevicescheduleinfo
|
Request format (with parameters) |
http://<host>:<port>/v2/botinsight/data/api/getdevicescheduleinfo?fromDate=2000-05-05&toDate=2020-07-07&limit=1000
|
Optional query parameters |
fromDate: The start date of the period for which you want to retrieve the data. toDate: The end date of the period for which you want to retrieve the data. The default date is the current date. limit: The number of records to be retrieved. The default limit is 1000. |
Returns | Returns information about the scheduled device and details of the bots running on the device. |
Sample Response |
|
User role | You must have the AAE_Bot Insight Admin or
AAE_Admin role to access the API. |