Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Get task log data

  • Updated: 2022/07/07
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Get task log data

Use the get task log data to retrieve the analytical variables data that is logged during a bot run.

Request

GET https://{{ControlRoomURL}}/v2/botinsight/data/api/gettasklogdata?botname=ATMReconciliation&fromdate=2022-07-04T00%3A00%3A00&todate=2022-07-07T23%3A59%3A59&limit=100&pageno=1
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.
The URL includes the example query parameter botname. For large datasets, use the pageno and limit parameters to avoid a timeout error.
  • You must have the AAE_Bot Insight Admin role and the Bot Insight license.
  • The bot must run at least for one time with the Bot Creator (Private workspace).
  • The bot must be checked in and deployed to the public workspace.

Request Parameters

Parameter Type Required Description
botname string No Name of the bots for which you retrieve data

Enter up to 10 bot names and separate each name with a comma.

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

pageno integer No Page number from which to retrieve the data
limit integer No 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
  • Min value: 1
fromdate date No 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 date No End date of the period for which to retrieve the data
  • Format: yyyy-mm-ddThh:mm:ss
  • Default: current date
Note: View the migration status using the List migration results API.

Response

This response example contains data on the ATMReconciliation bot and the first record returned.

{
    "businessData": [
        {
            "totalRecords": 1,
            "count": 1,
            "pageNo": 1,
            "botId": "PROD_581",
            "botName": "ATMReconciliation",
            "repositoryPath": "repository:///Automation%20Anywhere/Bots/Gettasklogdata?fileId=580&workspace=PRIVATE&version=0&label=",
            "list": [
                {
                    "transactionName": "Default",
                    "transactions": [
                        {
                            "runId": "e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e",
                            "transactionId": "2bda3a08-3049-4147-9e2b-8dc9dd8d7665",
                            "dateLogged": "2022-07-06T10:33:11",
                            "variables": {
                                "variable1": "123.0",
                                "varible3": "789.0",
                                "variable2": "456.0"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Response Parameters

Parameter Type Description
runId String Identifier for the bot run that retrieved this data. All the transactions in a single run have a common runId.
transactionId String Identifier for the data set that was retrieved in a single loop iteration.
dateLogged date Date and time the bot retrieved the data. Format: yyyy-mm-ddThh:mm:ss
variables Any Variable names and values.
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.
Send Feedback