The Automation Anywhere Bot Insight API exposes real-time business process analytics and operational intelligence data collected during bot execution. It allows developers to retrieve KPIs, bot run histories, performance rankings, and failure analytics from the Control Room programmatically. Results are paginated in sets of 1000 records and can be filtered by date ranges in ISO 8601 format.
openapi: 3.1.0
info:
title: Automation Anywhere Bot Insight API
description: >-
The Automation Anywhere Bot Insight API exposes real-time business process
analytics and operational intelligence data collected during bot execution.
It allows developers to retrieve KPIs, bot run histories, task metadata,
task variable profiles, and audit trail data from the Control Room
programmatically. Results are paginated in sets of 1000 records and can
be filtered by date ranges in ISO 8601 format. This API is commonly used
to feed bot performance data into external dashboards, BI tools such as
Tableau, and data warehouses for enterprise reporting. Access requires the
AAE_Bot Insight Admin or AAE_Admin role.
version: '2019'
contact:
name: Automation Anywhere Support
url: https://support.automationanywhere.com
termsOfService: https://www.automationanywhere.com/terms-of-service
externalDocs:
description: Automation Anywhere Bot Insight API Documentation
url: https://docs.automationanywhere.com/bundle/enterprise-v11.3/page/enterprise/topics/bot-insight/user/bot-insight-apis.html
servers:
- url: https://{controlRoomUrl}/v2/botinsight/data/api
description: Automation Anywhere Bot Insight API
variables:
controlRoomUrl:
default: your-control-room.automationanywhere.com
description: Your Control Room hostname
tags:
- name: AuditData
description: Retrieve Control Room audit trail data
- name: BotRunData
description: Retrieve bot execution run data and performance metrics
- name: TaskData
description: Retrieve task metadata, variable profiles, and task-level logs
security:
- bearerAuth: []
- xAuthorization: []
paths:
/getbotrundata/{startIndex}/{startDate}:
get:
operationId: getBotRunData
summary: Get bot run data
description: >-
Retrieves bot execution run records for a specific date or date range.
Each record contains details about a single bot run including user,
device, start/end times, status, and performance metrics. Results are
paginated at 1000 records per request. Dates must be in ISO 8601 format
and the date range cannot exceed 60 days.
tags:
- BotRunData
parameters:
- $ref: '#/components/parameters/StartIndexParam'
- $ref: '#/components/parameters/StartDateParam'
responses:
'200':
description: Bot run data records
content:
application/json:
schema:
$ref: '#/components/schemas/BotRunDataResponse'
'400':
description: Bad request or invalid date format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required or insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/gettaskmetadata/{taskName}:
get:
operationId: getTaskMetadata
summary: Get task metadata
description: >-
Retrieves metadata for a specific bot task including its configured
KPI variables, data types, and analytics dimensions. The task name
must match the Analytics display name configured in the Bot Insight
dashboard for the task.
tags:
- TaskData
parameters:
- $ref: '#/components/parameters/TaskNameParam'
responses:
'200':
description: Task metadata
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMetadataResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Task not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/gettaskvariableprofile/{taskName}:
get:
operationId: getTaskVariableProfile
summary: Get task variable profile
description: >-
Retrieves the variable profile (analytics KPI data) for a specific bot
task within a given date range. Returns aggregated values for each KPI
variable tracked during bot execution. Dates are provided as query
parameters in ISO 8601 format.
tags:
- TaskData
parameters:
- $ref: '#/components/parameters/TaskNameParam'
- $ref: '#/components/parameters/FromDateParam'
- $ref: '#/components/parameters/ToDateParam'
responses:
'200':
description: Task variable profile data
content:
application/json:
schema:
$ref: '#/components/schemas/TaskVariableProfileResponse'
'400':
description: Bad request or invalid date range
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/gettasklogdata/{taskName}/{startIndex}/{startDate}:
get:
operationId: getTaskLogData
summary: Get task log data
description: >-
Retrieves detailed execution log data for a specific bot task, including
per-run KPI variable values. Results are paginated at 1000 records per
request starting from the given index. Used to extract raw bot analytics
data for integration with external BI tools and data warehouses.
tags:
- TaskData
parameters:
- $ref: '#/components/parameters/TaskNameParam'
- $ref: '#/components/parameters/StartIndexParam'
- $ref: '#/components/parameters/StartDateParam'
responses:
'200':
description: Task log data records
content:
application/json:
schema:
$ref: '#/components/schemas/TaskLogDataResponse'
'400':
description: Bad request or invalid date format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getaudittraildata/{startIndex}/{startDate}:
get:
operationId: getAuditTrailData
summary: Get audit trail data
description: >-
Retrieves Control Room audit trail records capturing administrative
and operational events such as user logins, bot deployments, role
changes, and configuration updates. Results are paginated at 1000
records per request. Requires Bot Insight Admin or AAE_Admin role.
tags:
- AuditData
parameters:
- $ref: '#/components/parameters/StartIndexParam'
- $ref: '#/components/parameters/StartDateParam'
responses:
'200':
description: Audit trail records
content:
application/json:
schema:
$ref: '#/components/schemas/AuditTrailResponse'
'400':
description: Bad request or invalid date format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required or insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token obtained from the Authentication API
xAuthorization:
type: apiKey
in: header
name: X-Authorization
description: JWT token obtained from the Authentication API
parameters:
StartIndexParam:
name: startIndex
in: path
required: true
description: >-
Zero-based record index for pagination. Set to 0 to retrieve the first
page of 1000 records, then increment by 1000 for subsequent pages.
schema:
type: integer
minimum: 0
default: 0
StartDateParam:
name: startDate
in: path
required: true
description: Start date for the data query in ISO 8601 format (YYYY-MM-DD)
schema:
type: string
format: date
TaskNameParam:
name: taskName
in: path
required: true
description: >-
Analytics display name of the bot task as configured in the Bot Insight
dashboard (e.g., "Analytics_ATM Reconciliation")
schema:
type: string
FromDateParam:
name: from
in: query
required: false
description: Start of the date range in ISO 8601 format (YYYY-MM-DD)
schema:
type: string
format: date
ToDateParam:
name: to
in: query
required: false
description: End of the date range in ISO 8601 format (YYYY-MM-DD). Must not be more than 60 days after the from date.
schema:
type: string
format: date
schemas:
BotRunDataResponse:
type: object
description: Paginated response containing bot run execution records
properties:
totalRecords:
type: integer
description: Total number of bot run records available from the start date
botRunDataList:
type: array
description: List of individual bot run records
items:
$ref: '#/components/schemas/BotRunRecord'
BotRunRecord:
type: object
description: A single bot execution run record with performance and identity metadata
properties:
id:
type: integer
format: int64
description: Unique identifier of the bot run record
userName:
type: string
description: Username of the Control Room user who ran the bot
firstName:
type: string
description: First name of the user who ran the bot
lastName:
type: string
description: Last name of the user who ran the bot
email:
type: string
format: email
description: Email address of the user who ran the bot
hostName:
type: string
description: Hostname of the Bot Runner device where the bot executed
iPAddress:
type: string
description: IP address of the Bot Runner device
fileName:
type: string
description: Name of the bot file that was executed
startTime:
type: string
format: date-time
description: ISO 8601 timestamp when the bot execution started
endTime:
type: string
format: date-time
description: ISO 8601 timestamp when the bot execution ended
status:
type: string
description: Final execution status of the bot run
enum:
- COMPLETED
- FAILED
- STOPPED
- IN_PROGRESS
totalLines:
type: integer
description: Total number of task lines executed during the run
timeTaken:
type: integer
description: Total execution time in milliseconds
successIndicator:
type: boolean
description: Whether the bot run completed successfully
TaskMetadataResponse:
type: object
description: Metadata about a specific bot task's analytics configuration
properties:
taskName:
type: string
description: Analytics display name of the task
variables:
type: array
description: KPI variables tracked for this task
items:
$ref: '#/components/schemas/TaskVariable'
TaskVariable:
type: object
description: A single KPI variable tracked during bot task execution
properties:
name:
type: string
description: Variable name as defined in the bot
type:
type: string
description: Data type of the variable (e.g., STRING, NUMBER, DATE)
displayName:
type: string
description: Human-readable display name for dashboards
TaskVariableProfileResponse:
type: object
description: Aggregated variable profile data for a task over a date range
properties:
taskName:
type: string
description: Name of the task
from:
type: string
format: date
description: Start of the reporting date range
to:
type: string
format: date
description: End of the reporting date range
profiles:
type: array
description: Aggregated values for each KPI variable
items:
$ref: '#/components/schemas/VariableProfile'
VariableProfile:
type: object
description: Aggregated profile data for a single KPI variable
properties:
variableName:
type: string
description: Name of the KPI variable
totalValue:
type: string
description: Aggregated total value across all runs in the date range
runCount:
type: integer
description: Number of bot runs contributing to this profile
TaskLogDataResponse:
type: object
description: Paginated task-level log data records with per-run KPI values
properties:
totalRecords:
type: integer
description: Total number of log records available
logData:
type: array
description: List of task log records
items:
$ref: '#/components/schemas/TaskLogRecord'
TaskLogRecord:
type: object
description: A single task execution log entry with KPI variable values
properties:
id:
type: integer
format: int64
description: Unique identifier of the log record
taskName:
type: string
description: Name of the bot task
runDate:
type: string
format: date-time
description: ISO 8601 timestamp of the bot run
variables:
type: object
description: Map of KPI variable names to their recorded values for this run
additionalProperties:
type: string
AuditTrailResponse:
type: object
description: Paginated audit trail records from the Control Room
properties:
totalRecords:
type: integer
description: Total number of audit records available from the start date
auditData:
type: array
description: List of audit trail records
items:
$ref: '#/components/schemas/AuditRecord'
AuditRecord:
type: object
description: A single Control Room audit trail event record
properties:
id:
type: integer
format: int64
description: Unique identifier of the audit record
activityType:
type: string
description: Category of the audit activity (e.g., USER_LOGIN, BOT_DEPLOY)
createdBy:
type: string
description: Username of the user who triggered the audited event
createdOn:
type: string
format: date-time
description: ISO 8601 timestamp of the audited event
detail:
type: string
description: Detailed description of the audited action
environmentName:
type: string
description: Name of the Control Room environment
eventDescription:
type: string
description: Human-readable description of the event
hostName:
type: string
description: Hostname of the system where the event occurred
objectName:
type: string
description: Name of the resource object affected by the event
requestId:
type: string
description: Unique request identifier for tracing
source:
type: string
description: Source system or interface that triggered the event
status:
type: string
description: Outcome status of the audited action
userName:
type: string
description: Username associated with the event
Error:
type: object
description: Standard error response
properties:
code:
type: string
description: Error code
message:
type: string
description: Human-readable error description