BotInsight API

Automation Anywhere bots are built, run, and monitored in the Control Room. Bot Insight accesses real-time business insights and digital workforce performance data to use content-level productivity data from the bots that are deployed.
Prerequisites

Users with the AAE_Bot Insight Admin or AAE_Admin role and the Bot Insight license can access the Bot Insight API to retrieve business data.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

BusinessData

delete /data/api/deletetasklogdata
get /data/api/gettasklogdata
get /data/api/gettaskvariableprofile

OperationsData

get /data/api/getaudittraildata
get /data/api/getbotrundata

BusinessData

Up

delete /data/api/deletetasklogdata

Delete Bot Task Log Data (dataApiDeletetasklogdataDelete)

Delete the business data that is logged in the Bot Insight database on a deployed bot.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body DeleteBusinessDataRequest (required)

Body Parameter —

Return type

DeleteBusinessDataResponse

Example data

Content-Type: application/json

{
  "deleteCount" : 0,
  "botName" : "botName",
  "repositoryPath" : "repositoryPath"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Bot Business Data Retrieved DeleteBusinessDataResponse

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource not found

407

Authentication Required

409

Conflict

500

Internal Server error

Up

get /data/api/gettasklogdata

Get Task Log Data (dataApiGettasklogdataGet)

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

Query parameters

botname (optional)

Query Parameter — Name of the Bot for which you want to retrieve the data

fromdate (optional)

Query Parameter — Start date of the period for which to retrieve the data (yyyy-mm-ddThh:mm:ss)

todate (optional)

Query Parameter — End date of the period for which to retrieve the data (yyyy-mm-ddThh:mm:ss)

limit (optional)

Query Parameter — The limit of the API response that user want to retrieve

pageno (optional)

Query Parameter — Page number from which to retrieve the data

Return type

BusinessData

Example data

Content-Type: application/json

{
  "totalRecords" : "1",
  "pageNo" : "1",
  "botName" : "BotSampleName",
  "repositoryPath" : "repository:///Automation%20Anywhere/Bots/Samplebot?fileId=580&workspace=PRIVATE&version=0&label=",
  "count" : "1",
  "list" : [ {
    "transactionName" : "Default",
    "transactions" : [ {
      "variables" : [ {
        "value" : "123",
        "key" : "variable1"
      }, {
        "value" : "123",
        "key" : "variable1"
      } ],
      "dateLogged" : "2022-09-06T10:33:11Z",
      "runId" : "e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e",
      "transactionId" : "2bda3a08-3049-4147-9e2b-8dc9dd8d7665"
    }, {
      "variables" : [ {
        "value" : "123",
        "key" : "variable1"
      }, {
        "value" : "123",
        "key" : "variable1"
      } ],
      "dateLogged" : "2022-09-06T10:33:11Z",
      "runId" : "e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e",
      "transactionId" : "2bda3a08-3049-4147-9e2b-8dc9dd8d7665"
    } ]
  }, {
    "transactionName" : "Default",
    "transactions" : [ {
      "variables" : [ {
        "value" : "123",
        "key" : "variable1"
      }, {
        "value" : "123",
        "key" : "variable1"
      } ],
      "dateLogged" : "2022-09-06T10:33:11Z",
      "runId" : "e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e",
      "transactionId" : "2bda3a08-3049-4147-9e2b-8dc9dd8d7665"
    }, {
      "variables" : [ {
        "value" : "123",
        "key" : "variable1"
      }, {
        "value" : "123",
        "key" : "variable1"
      } ],
      "dateLogged" : "2022-09-06T10:33:11Z",
      "runId" : "e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e",
      "transactionId" : "2bda3a08-3049-4147-9e2b-8dc9dd8d7665"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Bot Business Data Retrieved BusinessData

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource not found

407

Authentication Required

409

Conflict

500

Internal Server error

Up

get /data/api/gettaskvariableprofile

Get Bot Variable Profile (dataApiGettaskvariableprofileGet)

Use Get Bot Variable Profile to retrieve information about the variables in deployed bots, such as the variable name, data type, minimum value, and maximum value.

Query parameters

botname (optional)

Query Parameter — Name of the Bot for which you want to retrieve data

repositorypath (optional)

Query Parameter — Control Room repository path of the bot

Return type

ProfileVariable

Example data

Content-Type: application/json

{
  "profileVariables" : [ {
    "minimumValue" : 789.0,
    "variableName" : "transactionStatus",
    "averageOfValues" : 789.0,
    "internalVariableName" : "transactionStatus",
    "displayName" : "Transaction Status",
    "attributeType" : "NUMERIC",
    "sumOfValue" : 789.0,
    "addedState" : "SAME",
    "totalDistinct" : 1,
    "totalNullRecords" : 0,
    "maximumValue" : 789.0,
    "enabled" : "Y"
  }, {
    "minimumValue" : 789.0,
    "variableName" : "transactionStatus",
    "averageOfValues" : 789.0,
    "internalVariableName" : "transactionStatus",
    "displayName" : "Transaction Status",
    "attributeType" : "NUMERIC",
    "sumOfValue" : 789.0,
    "addedState" : "SAME",
    "totalDistinct" : 1,
    "totalNullRecords" : 0,
    "maximumValue" : 789.0,
    "enabled" : "Y"
  } ],
  "totalRecords" : "totalRecords",
  "standardDashboardName" : "SampleDashboard",
  "botName" : "BotSampleName",
  "botId" : "PROD_581"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Bot Business Data Retrieved ProfileVariable

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource not found

407

Authentication Required

409

Conflict

500

Internal Server error

OperationsData

Up

get /data/api/getaudittraildata

Get Audit Trail Data Detail (dataApiGetaudittraildataGet)

Retrieve information about Control Room events.

Query parameters

pageno (optional)

Query Parameter — Page number from which to retrieve the Bot Run Data

limit (optional)

Query Parameter — Optional field.Limits the number of results returned. Defaults to 1000.

fromDate (optional)

Query Parameter — The starting timestamp for the date range. (yyyy-mm-ddThh:mm:ss)

toDate (optional)

Query Parameter — The ending timestamp for the date range. (yyyy-mm-ddThh:mm:ss)

Return type

AuditTrailDataResponse

Example data

Content-Type: application/json

{
  "totalRecords" : 0,
  "botRunDataList" : [ {
    "hostName" : "192.110.10.10",
    "source" : "Control Room",
    "userName" : "botcreate_user",
    "createdOn" : "2022-10-03T13:49:55Z",
    "createdBy" : 10,
    "environmentName" : "DEV",
    "requestId" : "f59a56a6dee160d8",
    "eventDescription" : "User botcreate_user created",
    "objectName" : "Sample role",
    "detail" : {
      "newValue" : "newValue",
      "attribute" : "attribute"
    },
    "id" : "1011",
    "activityType" : "MULTI_LOGIN",
    "status" : "Successful"
  }, {
    "hostName" : "192.110.10.10",
    "source" : "Control Room",
    "userName" : "botcreate_user",
    "createdOn" : "2022-10-03T13:49:55Z",
    "createdBy" : 10,
    "environmentName" : "DEV",
    "requestId" : "f59a56a6dee160d8",
    "eventDescription" : "User botcreate_user created",
    "objectName" : "Sample role",
    "detail" : {
      "newValue" : "newValue",
      "attribute" : "attribute"
    },
    "id" : "1011",
    "activityType" : "MULTI_LOGIN",
    "status" : "Successful"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Bot Business Data Retrieved AuditTrailDataResponse

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource not found

407

Authentication Required

409

Conflict

500

Internal Server error

Up

get /data/api/getbotrundata

Get Bot Run Data (dataApiGetbotrundataGet)

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

Query parameters

pageno (optional)

Query Parameter — The page number of the Bot Run Data that you want to retrieve.

limit (optional)

Query Parameter — Optional field. Limits the number of results returned. Defaults to 1000.

fromDate (optional)

Query Parameter — The starting timestamp for the date range. (yyyy-mm-ddThh:mm:ss)

toDate (optional)

Query Parameter — The ending timestamp for the date range. (yyyy-mm-ddThh:mm:ss)

Return type

BotRunDataResponse

Example data

Content-Type: application/json

{
  "totalRecords" : 0,
  "botRunDataList" : [ {
    "hostName" : "192.120.10.11",
    "timeTaken" : 1820,
    "fileName" : "Migration-Excel-DB",
    "endDate" : "2022-10-28T06:36:36Z",
    "totalLines" : 3,
    "progress" : 100,
    "id" : 60,
    "userName" : "botrun_user",
    "fileType" : "RUN_NOW",
    "startDate" : "2022-10-27T06:36:36Z",
    "status" : "COMPLETED",
    "currentLine" : 3
  }, {
    "hostName" : "192.120.10.11",
    "timeTaken" : 1820,
    "fileName" : "Migration-Excel-DB",
    "endDate" : "2022-10-28T06:36:36Z",
    "totalLines" : 3,
    "progress" : 100,
    "id" : 60,
    "userName" : "botrun_user",
    "fileType" : "RUN_NOW",
    "startDate" : "2022-10-27T06:36:36Z",
    "status" : "COMPLETED",
    "currentLine" : 3
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Bot Business Data Retrieved BotRunDataResponse

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource not found

407

Authentication Required

409

Conflict

500

Internal Server error

Models

Methods

`AuditTrailData` Up

activityType (optional)

String Defines the job activity type

example: MULTI_LOGIN

createdBy (optional)

Integer ID of the user

example: 10

createdOn (optional)

String On which this has been created

example: 2022-10-03T13:49:55Z

detail (optional)

Object Detail about the activity

environmentName (optional)

String Environment Name

example: DEV

eventDescription (optional)

String Event Description

example: User botcreate_user created

hostName (optional)

String Host Name

example: 192.110.10.10

id (optional)

String Activity Id

example: 1011

objectName (optional)

String Object Name

example: Sample role

requestId (optional)

String Request Id

example: f59a56a6dee160d8

source (optional)

String Activity Source

example: Control Room

status (optional)

String Activity Status

example: Successful

userName (optional)

String Name of the user who performed the activity

example: botcreate_user

`AuditTrailDataResponse` Up

totalRecords (optional)

Integer Total Records that has retrieved as part of the request

botRunDataList (optional)

array[AuditTrailData]

`BotRunData` Up

id (optional)

Integer The bot run unique Id for the particular run.

example: 60

userName (optional)

String The user name of the user who is running the bot.

example: botrun_user

hostName (optional)

String The host Name

example: 192.120.10.11

fileName (optional)

String Bot File Name

example: Migration-Excel-DB

fileType (optional)

String File Type associated to this bot. <ul> <li>WORKORDER - Depicts the status of the workitems uploaded from the CSV file</li> <li>WLM_TASK - A Work load management bot</li> <li>EXPORT - Bot export</li> <li>API - A bot that is run from an API</li> <li>AARI - A process bot</li> <li>RUN_NOW - A regular run as a users bot</li> <li>SCHEDULED - A scheduled bot</li> <li>TRIGGER - A triggered bot</li> <li>AUDIT_EXPORT - Audit export</li> <li>QUEUE_EXPORT - Queue export</li> <li>QUEUE_IMPORT - Queue import</li> <li>WORKITEM_EXPORT - List of Workitem export in CSV</li></ul>

Enum:

WORKORDER

WLM_TASK

EXPORT

API

AARI

RUN_NOW

SCHEDULED

TRIGGER

AUDIT_EXPORT

QUEUE_EXPORT

QUEUE_IMPORT

WORKITEM_EXPORT

example: RUN_NOW

startDate (optional)

String The date and time of when this bot started.

example: 2022-10-27T06:36:36Z

endDate (optional)

String The date and time of when this bot ended.

example: 2022-10-28T06:36:36Z

status (optional)

String The status of the bot.

example: COMPLETED

totalLines (optional)

Integer Total number of command lines the bot contains.

example: 3

currentLine (optional)

Integer The current Line that bot is processing

example: 3

timeTaken (optional)

Integer Time taken in milliseconds by the bot to complete the operation.

example: 1820

progress (optional)

Integer The progress of the bot in percentage.

example: 100

`BotRunDataResponse` Up

totalRecords (optional)

Integer Total Records that has retrieved as part of the request

botRunDataList (optional)

array[BotRunData] The array of Bot Run Data objects.

`BusinessData` Up

totalRecords

String Total Records avilable

example: 1

count

String Number of Records that has been retrieved for this request

example: 1

pageNo

String Retrieved page Number

example: 1

botName

String Retrieved bot name

example: BotSampleName

repositoryPath

String Repository Path of the given bot

example: repository:///Automation%20Anywhere/Bots/Samplebot?fileId=580&workspace=PRIVATE&version=0&label=

list

array[Transactions]

`BusinessDataObject` Up

runId (optional)

String Run Id of the Bot ran

example: e29732ad-5339-4012-941b-e9a1eb47806c_1a82fe211fc8865e

transactionId (optional)

String Transaction Id of the Bot ran

example: 2bda3a08-3049-4147-9e2b-8dc9dd8d7665

dateLogged (optional)

Date Date and Time that bot logged the data format: date-time

example: 2022-09-06T10:33:11Z

variables (optional)

array[Variables]

`DeleteBusinessDataRequest` Up

botName (optional)

String Name of the bot

example: SampleBot

repositoryPath (optional)

String Control Room repository path of the bot

example: repository:///Automation%20Anywhere/Bots/Samplebot?fileId=580&workspace=PRIVATE&version=0&label=

environment (optional)

String Specifies the environment of the bot

example: Prod

runId (optional)

String Bot Run Id. If you provide Run Id then fromDate and toDate is not required.

transactionId (optional)

String Bot Transaction Id. This is an optional field but when user provide Transaction Id then it must be given along with the Run Id.

fromDate (optional)

String Start date of the period for which to you want to delete the data (yyyy-mm-ddThh:mm:ss). Either provide the fromDate or runId.

example: 2022-09-06T00:00:00

toDate (optional)

String To Date (yyyy-mm-ddThh:mm:ss) Till which date user want to delete

example: 2022-09-09T12:00:00

`DeleteBusinessDataResponse` Up

botName (optional)

String Name of the bot

repositoryPath (optional)

String Repository of the bot

deleteCount (optional)

Integer number rows that deleted from db

`Error` Up

Message describing error

`ProfileVariable` Up

botId (optional)

String Id of the bot

example: PROD_581

botName (optional)

String Name of the bot

example: BotSampleName

totalRecords (optional)

String Total Records that is avialable in DB

standardDashboardName (optional)

String Standard Name of the Business Dashboard

example: SampleDashboard

profileVariables (optional)

array[ProfileVariableObject]

`ProfileVariableObject` Up

variableName (optional)

String Name of the profile variable

example: transactionStatus

internalVariableName (optional)

String Internal Name of the profile variable

example: transactionStatus

displayName (optional)

String Display Name of the profile variable

example: Transaction Status

attributeType (optional)

String Attribute Type of the profile variable

example: NUMERIC

sumOfValue (optional)

BigDecimal Sum of the value

example: 789.0

minimumValue (optional)

BigDecimal Minimum value

example: 789.0

maximumValue (optional)

BigDecimal Maximum value

example: 789.0

averageOfValues (optional)

BigDecimal Average of values

example: 789.0

totalDistinct (optional)

Integer Total number of distinct

example: 1

totalNullRecords (optional)

Integer Total number of null records

example: 0

enabled (optional)

String Is the variable enabled or not

example: Y

addedState (optional)

String Added state

example: SAME

`Transactions` Up

transactionName (optional)

String Specifies the Transaction Name

example: Default

transactions (optional)

array[BusinessDataObject]

`Variables` Up

key (optional)

String variable key

example: variable1

value (optional)

String variable value

example: 123

Automation 360

BotInsight API