Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Get task log data

  • Updated: 8/27/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Get task log data

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

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 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.

To retrieve business data on a specific bot, you provide the following query parameters to the API:

Parameter Required Type Description
botname no string 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 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
  • Min value: 1
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/gettasklogdata?botname=ATMReconciliation
    The URL includes the example query parameter botname. For large datasets, we recommend you use the pageno and limit parameters to avoid a timeout error.
  3. Send the request.
    Response body: This response example contains data on the ATMReconciliation bot and the first record returned. To keep this block of code short, the remaining 22 records are omitted. The response includes the following output parameters:
    Parameter Description Type
    runId Identifier for the bot run that retrieved this data

    All the transactions in a single run have a common runId.

    string
    transactionId Identifier for the data set that was retrieved in a single loop iteration string
    dateLogged Date and time on which the bot retrieved the data

    Format: yyyy-mm-ddThh:mm:ss

    date
    variables Variable names and values dictionary of strings and numbers
    {
       "businessData":[
          {
             "totalRecords":23,
             "count":23,
             "pageNo":1,
             "botId":"PROD_12",
             "botName":"ATMReconciliation",
             "repositoryPath":"repository:///Automation%20Anywhere/Bots/folder_6809/ATMReconciliation?fileId=19163&workspace=PRIVATE",
             "list":[
                {
                   "transactionName":"block1",
                   "transactions":[
                            {
                                "runId": "a2b0a033-3aa6-43b0-a2c7-da2c21a9f593_5151d69b5cb3ddf1",
                                "transactionId": "8567aa95-3b5b-4092-a0a9-fc94302c32fb",
                                "dateLogged": "2020-10-16T08:05:04",
                                "variables": {
                                    "bank_name": "TechCU",
                                    "status": "Not Matched",
                                    "date": "1477267200000",
                                    "colour_code": "Yellow",
                                    "card_type": "diners-club-enroute",
                                    "amount": "210.0",
                                    "state_code": "NJ",
                                    "transaction_type": "Deposit",
                                    "zip_code": "7104",
                                    "country_code": "US",
                                    "reason": "Need Attention"
                                }
                           ]
                },
     // The remaining 22 records are 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