Get bot run data

Retrieve information about a bot run, such as the server information and whether it ran successfully or encountered an error.

Request

GET http://{{ControlRoomURL}}/v2/botinsight/data/api/getbotrundata?pageno={pageno}&limit={limit}&fromDate={fromDate}&toDate={toDate}

Header: X-Authorization <<authentication token>>

All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.
To view the bot run data, you must have one of the following:
- AAE_BOT_INSIGHT_ADMIN role
- ANALYTICSCLIENT_VALUE license along with AAE_ADMIN role

Request parameters


Parameter	Type	Required	Description
pageno	Integer	No	The page number of the Bot Run Data that you want to retrieve.
limit	Interger	No	Limits the number of results returned. Defaults to 1000. For example, if you specify the limit as `2500` to retrieve a total of 10000 records, then the information retrieved is as follows: 0 page returns 1 - 2500 1st page returns 2501 - 5000 2nd page returns 5001 - 7500 3rd page returns 7501 - 10000
fromDate	String	No	The starting timestamp for the date range. If you do not provide this parameter, the API will return all available data. Format: `yyyy-mm-ddThh:mm:ss`
toDate	String	No	The ending timestamp for the date range. Format: `yyyy-mm-ddThh:mm:ss` Default: current date

GET http://{{ControlRoomURL}}/v2/botinsight/data/api/getbotrundata?pageno=1&limit=2&fromDate=2022-01-27T00%3A30%3A00Z&toDate=2022-02-27T06%3A30%3A00Z

Response

{
   "totalRecords":2,
   "botRunDataList":[
      {
         "id":60,
         "userName":"runner",
         "hostName":"WIN-MT6N77BI0C2",
         "fileName":"newtestbot27",
         "fileType":"RUN_NOW",
         "startDate":"2022-01-27T06:36:36Z",
         "endDate":"2022-01-27T06:36:36Z",
         "status":"FAILED",
         "totalLines":3,
         "currentLine":3,
         "timeTaken":1852,
         "progress":100
      },
      {
         "id":30,
         "userName":"runner",
         "hostName":"WIN-MT6N77BI0C2",
         "fileName":"Blm_test_bot",
         "fileType":"RUN_NOW",
         "startDate":"2022-01-28T11:33:25Z",
         "endDate":"2022-01-28T11:33:26Z",
         "status":"COMPLETED",
         "totalLines":3,
         "currentLine":3,
         "timeTaken":1820,
         "progress":100
      }
   ]
}

Response Parameters


Parameter	Type	Description
totatRecords	Integer	Total Records that has been retrieved as part of the request.
botRunDataList	Array	The array of Bot Run Data objects.
botRunDataList Object
id	Integer	The bot run unique Id for the particular run.
userName	String	The user name of the user who is running the bot.
hostName	String	The host name.
fileName	String	Bot file name.
fileType	String	File Type associated to this bot. Following are the possible values for the fileType: `TASK` : A regular bot. `WLM_TASK`: A Work life cycle management. `WORKFLOW`: This is a part of `WLM_TASK`. `WORKORDER`: This is a part of `WLM_TASK`. `AARI`: A process bot.
startDate	String	The date and time of when this bot started.
endDate	String	The date and time of when this bot ended.
status	String	The status of the bot. Following values are possible: `COMPLETED`: bot successfully completed execution. `DEPLOYED`: auto-login is successful and bot is deployed to a device. `DEPLOY_FAILED`: bot failed to deploy to the device. For example, if auto-login failed. `QUEUED`: requested user or device is busy running another execution. `PENDING_EXECUTION`: device has been selected, but bot has not yet been deployed to that device. `RUNNING` or `UPDATE`: bot is executing on a device. `RUN_FAILED`: bot failed after being deployed to a device. `RUN_PAUSED`: user paused the bot. `RUN_TIMED_OUT`: bot failed to complete tasks within a specific time period. `UNKNOWN`: connection between the service and the device was lost.
totalLines	Integer	Total number of command lines the bot contains.
currentLine	Integer	The current line the bot is processing.
timeTaken	Integer	Time taken in milliseconds by the bot to complete the operation.
progress	Integer	The progress of the bot in percentage.

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.