Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Get Bot Insight bot run data

  • Updated: 4/02/2021
    • Automation 360 v.x
    • Optimize
    • RPA Workspace
    • API docs

Get Bot Insight bot run data

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

Prerequisites

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.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • You must have the AAE_Bot Insight Admin or AAE_Admin role and the Bot Insight license.

To retrieve information about a bot run, you provide the following query parameters to the API:

Parameter Required Type Description
pageno no integer Page number from which to retrieve the data
limit no integer Specifies the number of parts in which the information is retrieved

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 no date Start date of the period for which to retrieve the data

If you do not provide this parameter, the API will return all available data.

Format: yyyy-mm-ddThh:mm:ss

toDate no date End date of the period for which to retrieve the data
  • Format: yyyy-mm-ddThh:mm:ss
  • Default: current date

Procedure

  1. Add the authentication token to the request header.
  2. Use the GET method and endpoint URL:<control_room_URL>/v2/botinsight/data/api/getbotrundata
  3. Send the request.
    Response body:
    {
      "totalRecords": 10000,
      "botRunDataList": [
        {
            "id": 8009,
            "userName": "usecase_14",
            "hostName": "usecase-botagen",
            "fileName": "ImageScraperBot",
            "fileType": "TASK",
            "startDate": "2020-09-06T18:32:27Z",
            "endDate": "2020-09-06T18:35:21Z",
            "status": "COMPLETED",
            "totalLines": 75,
            "currentLine": 75,
            "timeTaken": 176607.0,
            "progress": 100
            },
    // The remaining data is omited from this code example.
    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.
Send Feedback