Get bot variables data

Read and Review Automation Anywhere Documentation

Automation 360

Download PDF

Get bot variables data

Retrieve information about the variables in deployed bots, such as the variable name, data type, minimum value, and maximum value.

Prerequisites

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

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.
You must have the AAE_Bot Insight Admin role and the Bot Insight license.
The bot must be checked into the public workspace.
You must publish at least one dashboard to get the results using this API.

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


Parameter	Required	Type	Description
`botname`	no	string	Name of the bot for which data is retrieved
`repositorypath`	no	string	Control Room repository path of the bot

Procedure

Add the authentication token to the request header.
Use the GET method and endpoint URL:<control_room_URL>/v2/botinsight/data/api/gettaskvariableprofile

Send the request.

Response body: This response example contains data on the AnalyticsMortgageProcessing bot and the first record returned. To keep this block of code short, the remaining data is omitted.

{
    "dataProfiles": [
        {
            "botId": "PROD_40642",
            "botName": "AnalyticsMortgageProcessing",
            "standardDashboardName": "",
            "profileVariables": [
                {
                    "variableName": "state",
                    "displayName": "State",
                    "attributeType": "US_STATE_CODE",
                    "sumOfValue": 0.0,
                    "minimumValue": "",
                    "maximumValue": "",
                    "averageOfValues": 0.0,
                    "totalDistinct": "53",
                    "enabled": "Y",
                    "isTransactionVariable": ""
                },
// 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