The ACC Automations API provides KPI, ranking, run history, duration, and failure analytics for automations (bots) along with detailed execution search. Endpoints are under the base path /v1/acc/automation/* and support filtering, paging, and exporting. Core capabilities:

Overview KPIs (counts, success rate, average duration)
Ranked lists (most running, longest running, most failed)
Duration analytics (overall, grouped views, totals)
Execution listing (all, completed, failed)
Run history & about metadata (by workspace type or bot id)
CSV export endpoints for selected ranked / list data

Authentication: Supply X-Authorization or Authorization:Bearer <bearer token>. Permissions & Feature Flags: Access is controlled by Control Room permissions and feature licenses. Some endpoints may require additional feature flags.

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

AccAutomation

post /acc/automation/runhistory/export
post /acc/automation/runhistory/{workSpaceType}/export
post /acc/automation/{groupBy}/runduration/list/export
post /acc/automation/longestrunning/export
post /acc/automation/mostfailed/export
post /acc/automation/mostrunning/export
post /acc/automation/mostrunning/{workSpaceType}/export
get /acc/automation/{botId}/about
post /acc/automation/about/{workSpaceType}
post /acc/automation/overview
post /acc/automation/runduration
post /acc/automation/runduration/total
post /acc/automation/{groupBy}/runduration
post /acc/automation/overview/{workSpaceType}
post /acc/automation/botexecution/list
post /acc/automation/runhistory/{workSpaceType}
post /acc/automation/bot/completed
post /acc/automation/failures
post /acc/automation/bot/failed
post /acc/automation/{groupBy}/runduration/list
post /acc/automation/longestrunning
post /acc/automation/mostfailed
post /acc/automation/mostrunning
post /acc/automation/mostrunning/{workSpaceType}

AccAutomation

Up

post /acc/automation/runhistory/export

Export automation run history (CSV) (exportAutomationRunHistory)

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Automations-Run-History-last24hours-20251014-132353"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/runhistory/{workSpaceType}/export

Export automation run history (workspace scoped CSV) (exportAutomationRunHistoryByWorkspace)

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Private-Automations-Run-History-last24hours-20251014-133045"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/{groupBy}/runduration/list/export

Export grouped automation run duration list (CSV) (exportGroupedAutomationRunDuration)

Path parameters

groupBy (required)

Path Parameter — Field to group by for duration metrics (for automationName, deviceName, userName, executionStatus, executionType, licenseType).

Consumes

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

application/json

Request body

body TimeRangeFilterExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST7DAYS"
    },
    "sort" : null,
    "filter" : {
      "field" : "automationName",
      "value" : "bot",
      "operator" : "substring"
    },
    "fileName" : "Automation-run-hours-last7days-20251014-135056"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/longestrunning/export

Export longest running automations (CSV) (exportLongestRunningAutomations)

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Longest-Running-Automations-last24hours-20251013-205846"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostfailed/export

Export most failed automations (CSV) (exportMostFailedAutomations)

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Most-Failures-Automations-last24hours-20251013-205936"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostrunning/export

Export most running automations (CSV) (exportMostRunningAutomations)

Returns CSV stream of ranked most running automations.

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Most-Running-Automations-last24hours-20251013-205408"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostrunning/{workSpaceType}/export

Export most running automations (workspace scoped CSV) (exportMostRunningAutomationsByWorkspace)

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body TimeRangeExportRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "fileName" : "Most-Running-Automations-PRIVATE-last24hours-20251014-132800"
  }
}

Return type

byte[]

Example data

Content-Type: application/json

""

Produces

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

text/csv
application/json

Responses

200

CSV export byte[]

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

get /acc/automation/{botId}/about

Automation about metadata (getAutomationAbout)

Path parameters

botId (required)

Path Parameter — Unique bot (automation) identifier.

Return type

AutomationAboutResponse

Example data

Content-Type: application/json

{
  "lastModifiedDate" : "lastModifiedDate",
  "botName" : "botName",
  "botId" : 0,
  "lastSuccessfulRun" : {
    "endDateTime" : "endDateTime",
    "status" : "status"
  },
  "version" : "version",
  "technicalOwners" : [ {
    "firstName" : "firstName",
    "lastName" : "lastName",
    "type" : "type",
    "userName" : "userName",
    "userId" : 6
  }, {
    "firstName" : "firstName",
    "lastName" : "lastName",
    "type" : "type",
    "userName" : "userName",
    "userId" : 6
  } ]
}

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

About metadata AutomationAboutResponse

401

Authentication required Error

404

Not found Error

Up

post /acc/automation/about/{workSpaceType}

Automation about metadata (workspace scoped) (getAutomationAboutByWorkspace)

Returns about metadata for automations filtered by workspace type and optional id/userId context.

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body AutomationAboutWorkspaceRequest (required)

Body Parameter —

example:

{
  "value" : {
    "id" : "169794",
    "userId" : "41553"
  }
}

Return type

AutomationAboutResponse

Example data

Content-Type: application/json

{
  "lastModifiedDate" : "lastModifiedDate",
  "botName" : "botName",
  "botId" : 0,
  "lastSuccessfulRun" : {
    "endDateTime" : "endDateTime",
    "status" : "status"
  },
  "version" : "version",
  "technicalOwners" : [ {
    "firstName" : "firstName",
    "lastName" : "lastName",
    "type" : "type",
    "userName" : "userName",
    "userId" : 6
  }, {
    "firstName" : "firstName",
    "lastName" : "lastName",
    "type" : "type",
    "userName" : "userName",
    "userId" : 6
  } ]
}

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

About metadata AutomationAboutResponse

401

Authentication required Error

403

Forbidden Error

404

Not found Error

Up

post /acc/automation/overview

Automation overview KPIs (getAutomationOverview)

Returns high-level KPI metrics for automations in the tenant and (optionally) workspace type.

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationOverviewResponse

Example data

Content-Type: application/json

{
  "data" : [ {
    "field" : "string",
    "value" : "string"
  }, {
    "field" : "string",
    "value" : "string"
  } ]
}

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

Overview metrics response AutomationOverviewResponse

401

Authentication required Error

403

Forbidden Error

400

Bad Request Error

Up

post /acc/automation/runduration

Automation run duration distribution (getAutomationRunDuration)

Returns aggregated run duration statistics for automations over a time range.

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationRunDurationResponse

Example data

Content-Type: application/json

{
  "data" : [ {
    "time" : "string",
    "value" : "number"
  }, {
    "time" : "string",
    "value" : "number"
  } ],
  "timeUnit" : "string"
}

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

Duration metrics AutomationRunDurationResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/runduration/total

Total automation run time metrics (getAutomationTotalRunTime)

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationTotalRunTimeResponse

Example data

Content-Type: application/json

{
  "totalRunTime" : 123456789
}

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

Aggregated total run time in milliseconds AutomationTotalRunTimeResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/{groupBy}/runduration

Grouped automation run duration metrics (getGroupedAutomationRunDuration)

Path parameters

groupBy (required)

Path Parameter — Field to group by for duration metrics (for automationName, deviceName, userName, executionStatus, executionType, licenseType).

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationGroupedRunDurationResponse

Example data

Content-Type: application/json

{
  "groupByField" : "string",
  "groupBy" : [ {
    "fieldName" : "string",
    "runDurationMilliseconds" : "string",
    "percentageValue" : "number"
  }, {
    "fieldName" : "string",
    "runDurationMilliseconds" : "string",
    "percentageValue" : "number"
  } ]
}

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

Grouped duration metrics AutomationGroupedRunDurationResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/overview/{workSpaceType}

Workspace automation overview KPIs (getWorkspaceAutomationOverview)

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationOverviewResponse

Example data

Content-Type: application/json

{
  "data" : [ {
    "field" : "string",
    "value" : "string"
  }, {
    "field" : "string",
    "value" : "string"
  } ]
}

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

Overview metrics response AutomationOverviewResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/botexecution/list

Bot execution list (simplified) (listAutomationExecutions)

Returns a paginated list of recent bot executions with a simplified item model. This variant only supports paging (no filter/sort in this spec revision).

Consumes

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

application/json

Request body

body BotExecutionListRequest (required)

Body Parameter —

example:

{
  "value" : {
    "page" : {
      "offset" : 0,
      "length" : 15
    }
  }
}

Return type

BotExecutionListResponse

Example data

Content-Type: application/json

{
  "page" : {
    "offset" : "integer",
    "total" : "integer",
    "totalFilter" : "integer"
  },
  "list" : [ {
    "id" : "string",
    "name" : "string",
    "path" : "string",
    "userName" : "string",
    "deviceName" : "string",
    "startDateTime" : "string",
    "botId" : "string"
  }, {
    "id" : "string",
    "name" : "string",
    "path" : "string",
    "userName" : "string",
    "deviceName" : "string",
    "startDateTime" : "string",
    "botId" : "string"
  } ]
}

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

Simplified execution list response BotExecutionListResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/runhistory/{workSpaceType}

Automation run history (workspace scoped) (listAutomationRunHistoryByWorkspace)

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body TimeRangeSizeRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "size" : 100
  }
}

Return type

ExecutionResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 2,
    "offset" : 0
  },
  "list" : [ {
    "automationId" : "automationId",
    "queueId" : "queueId",
    "tenantUuid" : "e135e92d-27dd-405e-bc52-b8fad270476f",
    "fileName" : "testbot",
    "callbackInfo" : "callbackInfo",
    "type" : "TRIGGER",
    "deviceId" : "1",
    "createdOn" : "2022-04-14T06:36:25.873480700Z",
    "deviceName" : "AAUS34NS3RM",
    "modifiedOn" : "2022-04-14T06:35:24.773187700Z",
    "deploymentId" : "494562cb-7c24-41d2-ae0e-8b8c5084ae90",
    "automationName" : "testbot.2022.04.13.22.22.50.john_creator",
    "modifiedBy" : "john_creator",
    "id" : "972f41ee-90e7-4a62-8d1-055dc9c3b59c_668b1db6649c43da",
    "usingRdp" : true,
    "currentLine" : 1,
    "currentBotName" : "testbot",
    "endDateTime" : "2022-04-14T06:39:27.438843100Z",
    "message" : "message",
    "userName" : "john_unattended",
    "userId" : "1",
    "command" : "messageBox",
    "parentId" : "8f1d7270-3ca7-4c51-b412-2c214c6550cf",
    "canManage" : true,
    "initiationType" : "TRIGGER",
    "startDateTime" : "2022-04-14T06:39:24.254386346Z",
    "queueName" : "queueName",
    "createdBy" : "john_creator",
    "totalLines" : 1,
    "botLabel" : "PRODUCTION",
    "progress" : 100,
    "refId" : "4-0",
    "automationPriority" : "PRIORITY_MEDIUM",
    "activityType" : "BOT",
    "runElevated" : false,
    "status" : "COMPLETED",
    "fileId" : "1"
  }, {
    "automationId" : "automationId",
    "queueId" : "queueId",
    "tenantUuid" : "e135e92d-27dd-405e-bc52-b8fad270476f",
    "fileName" : "testbot",
    "callbackInfo" : "callbackInfo",
    "type" : "TRIGGER",
    "deviceId" : "1",
    "createdOn" : "2022-04-14T06:36:25.873480700Z",
    "deviceName" : "AAUS34NS3RM",
    "modifiedOn" : "2022-04-14T06:35:24.773187700Z",
    "deploymentId" : "494562cb-7c24-41d2-ae0e-8b8c5084ae90",
    "automationName" : "testbot.2022.04.13.22.22.50.john_creator",
    "modifiedBy" : "john_creator",
    "id" : "972f41ee-90e7-4a62-8d1-055dc9c3b59c_668b1db6649c43da",
    "usingRdp" : true,
    "currentLine" : 1,
    "currentBotName" : "testbot",
    "endDateTime" : "2022-04-14T06:39:27.438843100Z",
    "message" : "message",
    "userName" : "john_unattended",
    "userId" : "1",
    "command" : "messageBox",
    "parentId" : "8f1d7270-3ca7-4c51-b412-2c214c6550cf",
    "canManage" : true,
    "initiationType" : "TRIGGER",
    "startDateTime" : "2022-04-14T06:39:24.254386346Z",
    "queueName" : "queueName",
    "createdBy" : "john_creator",
    "totalLines" : 1,
    "botLabel" : "PRODUCTION",
    "progress" : 100,
    "refId" : "4-0",
    "automationPriority" : "PRIORITY_MEDIUM",
    "activityType" : "BOT",
    "runElevated" : false,
    "status" : "COMPLETED",
    "fileId" : "1"
  } ]
}

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

Execution list response ExecutionResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/bot/completed

Completed bot executions (simplified) (listCompletedAutomationExecutions)

Returns a list of recent completed bot executions within a time range. Simplified model supports timeRange and size only.

Consumes

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

application/json

Request body

body CompletedBotExecutionsRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST7DAYS"
    },
    "size" : 100
  }
}

Return type

CompletedBotExecutionListResponse

Example data

Content-Type: application/json

{
  "list" : [ {
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "startDateTime" : "string",
    "id" : "string"
  }, {
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "startDateTime" : "string",
    "id" : "string"
  } ]
}

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

Simplified completed executions response CompletedBotExecutionListResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/failures

Failed automation executions (listFailedAutomationExecutions)

Returns a paginated list of failed automation executions with error details.

Consumes

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

application/json

Request body

body AutomationFailuresRequest (required)

Body Parameter —

Return type

AutomationFailuresResponse

Example data

Content-Type: application/json

{
  "runs" : [ {
    "id" : "string",
    "errorMessage" : "string",
    "from" : "string",
    "to" : "string"
  }, {
    "id" : "string",
    "errorMessage" : "string",
    "from" : "string",
    "to" : "string"
  } ]
}

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

Failure executions list AutomationFailuresResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/bot/failed

Failed bot executions list (simplified) (listFailedBotExecutions)

Returns a list of recent failed bot executions within a time range. Simplified model supports timeRange and size only, with failureReason for each execution.

Consumes

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

application/json

Request body

body FailedBotExecutionsRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST30DAYS"
    },
    "size" : 100
  }
}

Return type

FailedBotExecutionListResponse

Example data

Content-Type: application/json

{
  "list" : [ {
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "startDateTime" : "string",
    "id" : "string",
    "failureReason" : "string"
  }, {
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "startDateTime" : "string",
    "id" : "string",
    "failureReason" : "string"
  } ]
}

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

Simplified failed executions response FailedBotExecutionListResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/{groupBy}/runduration/list

Grouped automation run duration list (listGroupedAutomationRunDuration)

Path parameters

groupBy (required)

Path Parameter — Field to group by for duration metrics (for automationName, deviceName, userName, executionStatus, executionType, licenseType).

Consumes

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

application/json

Request body

body TimeRangeFilterRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST7DAYS"
    },
    "sort" : null,
    "filter" : null,
    "page" : {
      "offset" : 0,
      "length" : 15
    }
  }
}

Return type

AutomationGroupedRunDurationListResponse

Example data

Content-Type: application/json

{
  "page" : {
    "offset" : "integer",
    "total" : "integer",
    "totalFilter" : "integer"
  },
  "list" : [ {
    "id" : "string",
    "fieldId" : "string",
    "automationName" : "string",
    "runDurationMilliseconds" : "string",
    "folderPath" : "string"
  }, {
    "id" : "string",
    "fieldId" : "string",
    "automationName" : "string",
    "runDurationMilliseconds" : "string",
    "folderPath" : "string"
  } ]
}

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

Grouped run duration ranked list AutomationGroupedRunDurationListResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/longestrunning

Longest running automations (listLongestRunningAutomations)

Lists automations by average / max run duration.

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationLongestRunningResponse

Example data

Content-Type: application/json

{
  "metrics" : [ {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "longestBotRun" : {
      "id" : "string",
      "botId" : "string",
      "runDurationMillisec" : "string",
      "from" : "string",
      "to" : "string",
      "averageRunDurationMillisec" : "string",
      "deviceId" : "string",
      "deviceName" : "string"
    }
  } ]
}

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

Ranked duration list AutomationLongestRunningResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostfailed

Automations with most failures (listMostFailedAutomations)

Lists automations ordered by failure count.

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationMostFailedResponse

Example data

Content-Type: application/json

{
  "metrics" : [ {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "failures" : {
      "count" : "string",
      "lastFailedReason" : "string"
    }
  }, {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "failures" : {
      "count" : "string",
      "lastFailedReason" : "string"
    }
  } ]
}

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

List of most frequently running automations with success / failure counts AutomationMostFailedResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostrunning

Most frequently running automations (listMostRunningAutomations)

Lists automations with highest execution counts in the time window.

Consumes

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

application/json

Request body

body TimeRangeRequest (required)

Body Parameter —

Return type

AutomationMostRunningResponse

Example data

Content-Type: application/json

{
  "metrics" : [ {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "count" : {
      "successful" : "string",
      "failed" : "string"
    }
  }, {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "count" : {
      "successful" : "string",
      "failed" : "string"
    }
  } ]
}

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

List of automations and run counts AutomationMostRunningResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Up

post /acc/automation/mostrunning/{workSpaceType}

Most running automations (workspace scoped) (listMostRunningAutomationsByWorkspace)

Path parameters

workSpaceType (required)

Path Parameter — Workspace type scope (for example PRIVATE, PUBLIC).

Consumes

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

application/json

Request body

body TimeRangeSizeRequest (required)

Body Parameter —

example:

{
  "value" : {
    "timeRange" : {
      "type" : "LAST24HOURS"
    },
    "size" : 100
  }
}

Return type

AutomationMostRunningResponse

Example data

Content-Type: application/json

{
  "metrics" : [ {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "count" : {
      "successful" : "string",
      "failed" : "string"
    }
  }, {
    "id" : "string",
    "botId" : "string",
    "name" : "string",
    "path" : "string",
    "count" : {
      "successful" : "string",
      "failed" : "string"
    }
  } ]
}

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

Workspace-scoped most running automations with success / failure counts AutomationMostRunningResponse

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

Models

Methods

Table of Contents

AutomationAboutResponse
AutomationAboutResponse_lastSuccessfulRun
AutomationAboutResponse_technicalOwners
AutomationAboutWorkspaceRequest
AutomationFailuresRequest
AutomationFailuresResponse
AutomationFailuresResponse_runs
AutomationGroupedRunDurationListResponse
AutomationGroupedRunDurationListResponse_list
AutomationGroupedRunDurationResponse
AutomationGroupedRunDurationResponse_groupBy
AutomationLongestRunningResponse
AutomationLongestRunningResponse_longestBotRun
AutomationLongestRunningResponse_metrics
AutomationMostFailedResponse
AutomationMostFailedResponse_failures
AutomationMostFailedResponse_metrics
AutomationMostRunningResponse
AutomationMostRunningResponse_count
AutomationMostRunningResponse_metrics
AutomationOverviewResponse
AutomationOverviewResponse_data
AutomationRunDurationResponse
AutomationRunDurationResponse_data
AutomationTotalRunTimeResponse
BotExecutionListItem
BotExecutionListRequest
BotExecutionListResponse
CompletedBotExecutionItem
CompletedBotExecutionListResponse
CompletedBotExecutionsRequest
Error
Execution
ExecutionResponse
FailedBotExecutionItem
FailedBotExecutionListResponse
FailedBotExecutionsRequest
Filter
PageRequest
PageResponse
Sort
TimeRange
TimeRangeExportRequest
TimeRangeFilterExportRequest
TimeRangeFilterRequest
TimeRangeRequest
TimeRangeSizeRequest

`AutomationAboutResponse` Up

About metadata for a single automation.

botId (optional)

Long format: int64

botName (optional)

String

version (optional)

String

lastModifiedDate (optional)

String ISO timestamp of last modification

technicalOwners (optional)

array[AutomationAboutResponse_technicalOwners]

lastSuccessfulRun (optional)

AutomationAboutResponse_lastSuccessfulRun

lastFailedRun (optional)

AutomationAboutResponse_lastSuccessfulRun

`AutomationAboutResponse_lastSuccessfulRun` Up

endDateTime (optional)

String

status (optional)

String

`AutomationAboutResponse_technicalOwners` Up

type (optional)

String Owner type (CREATOR or LAST_MODIFIER)

firstName (optional)

String

lastName (optional)

String

userName (optional)

String

userId (optional)

Long format: int64

`AutomationAboutWorkspaceRequest` Up

Request payload to retrieve automation about metadata scoped to a workspace type with optional automation id and user context.

id (optional)

String Optional automation identifier for which to fetch about metadata.

example: 169794

userId (optional)

String Optional user identifier providing context (e.g., personalization or access scoping).

example: 41553

`AutomationFailuresRequest` Up

Request payload for listing failed automation runs (simplified).

timeRange (optional)

TimeRange

botId (optional)

Long Optional bot identifier to scope failures. format: int64

example: 22

size (optional)

Integer Maximum number of failed runs to return.

example: 20

`AutomationFailuresResponse` Up

List of failed runs with error messages.

runs (optional)

array[AutomationFailuresResponse_runs]

`AutomationFailuresResponse_runs` Up

id (optional)

String Unique execution id

errorMessage (optional)

String Failure reason / stack or user-readable message

from (optional)

Date Start timestamp of the failed run format: date-time

to (optional)

Date End timestamp of the failed run format: date-time

`AutomationGroupedRunDurationListResponse` Up

Paginated grouped run duration list for a grouping dimension.

page (optional)

PageResponse

list (optional)

array[AutomationGroupedRunDurationListResponse_list]

`AutomationGroupedRunDurationListResponse_list` Up

id (optional)

String Unique identifier for the grouped metric entry.

fieldId (optional)

String Identifier of the grouped field value (e.g., automation id).

automationName (optional)

String Name of the automation when grouping by automation.

runDurationMilliseconds (optional)

String Total run duration in milliseconds for this grouping key (stringified).

folderPath (optional)

String Full path of the automation in the repository (if applicable).

`AutomationGroupedRunDurationResponse` Up

Aggregated run duration grouped by a field (e.g., deviceName, bot, workSpaceType) with percentage contribution.

groupByField (optional)

String The field name used for grouping.

example: deviceName

groupBy (optional)

array[AutomationGroupedRunDurationResponse_groupBy] Collection of grouped duration aggregates.

`AutomationGroupedRunDurationResponse_groupBy` Up

fieldName (optional)

String Value of the grouping field.

example: ip-172-151-15-1

runDurationMilliseconds (optional)

String Total run duration in milliseconds for this group (stringified).

example: 59376990

percentageValue (optional)

Double Percentage contribution of this group's duration to the overall total. format: double

example: 97.63

`AutomationLongestRunningResponse` Up

List of automations ranked by their longest (and average) run durations within the selected time range.

metrics (optional)

array[AutomationLongestRunningResponse_metrics]

`AutomationLongestRunningResponse_longestBotRun` Up

Details of the single longest execution observed in the period plus average duration stats.

id (optional)

String Execution id of the longest run

botId (optional)

String Bot id (may be 0 if derived)

runDurationMillisec (optional)

String Duration in milliseconds of the longest run (stringified)

from (optional)

Date Start timestamp of the longest run format: date-time

to (optional)

Date End timestamp of the longest run format: date-time

averageRunDurationMillisec (optional)

String Average run duration in milliseconds over all runs in the period (stringified)

deviceId (optional)

String Device id used for the longest run

deviceName (optional)

String Device name used for the longest run

`AutomationLongestRunningResponse_metrics` Up

id (optional)

String Unique automation metric id

botId (optional)

String Bot identifier

name (optional)

String Bot name

path (optional)

String Full repository path of the bot

longestBotRun (optional)

AutomationLongestRunningResponse_longestBotRun

`AutomationMostFailedResponse` Up

List of automations ranked by highest failed execution counts within the selected time range.

metrics (optional)

array[AutomationMostFailedResponse_metrics]

`AutomationMostFailedResponse_failures` Up

Failure statistics for this automation.

count (optional)

String Number of failed executions (stringified)

lastFailedReason (optional)

String Error message / reason from the latest failed execution

`AutomationMostFailedResponse_metrics` Up

id (optional)

String Unique automation metric id

botId (optional)

String Bot identifier

name (optional)

String Bot name

path (optional)

String Full repository path of the bot

failures (optional)

AutomationMostFailedResponse_failures

`AutomationMostRunningResponse` Up

List of most frequently running automations with aggregated run counts.

metrics (optional)

array[AutomationMostRunningResponse_metrics]

`AutomationMostRunningResponse_count` Up

successful (optional)

String Number of successful executions (stringified)

failed (optional)

String Number of failed executions (stringified)

`AutomationMostRunningResponse_metrics` Up

id (optional)

String Unique automation metric id

botId (optional)

String Bot identifier

name (optional)

String Bot name

path (optional)

String Full repository path of the bot

count (optional)

AutomationMostRunningResponse_count

`AutomationOverviewResponse` Up

Overview metrics returned as a list of key/value pairs (status category and its value).

data (optional)

array[AutomationOverviewResponse_data] Collection of overview metric entries.

`AutomationOverviewResponse_data` Up

field (optional)

String Metric / status category name.

Enum:

RUNNING

COMPLETED

FAILED

SCHEDULED

example: RUNNING

value (optional)

String Metric value (stringified to preserve large counts without overflow in some clients).

example: 209

`AutomationRunDurationResponse` Up

Time series of aggregated run duration values for the selected time range.

data (optional)

array[AutomationRunDurationResponse_data] Ordered list of time buckets and their aggregated duration values.

timeUnit (optional)

String Granularity of the time buckets.

Enum:

MINUTES

HOURS

DAYS

example: HOURS

`AutomationRunDurationResponse_data` Up

time (optional)

Date ISO 8601 timestamp representing the start of the time bucket. format: date-time

example: 2025-10-13T00:00Z

value (optional)

Double Aggregated run duration (e.g. total or average) for the bucket in milliseconds. format: double

example: 299724.0

`AutomationTotalRunTimeResponse` Up

Total cumulative run time across matching automations (milliseconds).

totalRunTime (optional)

Long Total run time in milliseconds. format: int64

example: 123456789

`BotExecutionListItem` Up

Simplified bot execution list item.

id (optional)

String Unique execution id

name (optional)

String Bot name at time of execution

path (optional)

String Repository path of the bot

userName (optional)

String Username that ran the bot

deviceName (optional)

String Device name where bot ran

startDateTime (optional)

Date Execution start timestamp format: date-time

botId (optional)

String Bot identifier

`BotExecutionListRequest` Up

Request for listing bot executions (simplified) using only paging.

page (optional)

PageRequest

`BotExecutionListResponse` Up

Simplified paginated bot execution list.

page (optional)

PageResponse

list (optional)

array[BotExecutionListItem]

`CompletedBotExecutionItem` Up

Simplified completed bot execution.

botId (optional)

String Bot identifier

name (optional)

String Bot name

path (optional)

String Repository path of the bot

startDateTime (optional)

Date Start time of the execution format: date-time

id (optional)

String Unique execution id

`CompletedBotExecutionListResponse` Up

List of completed bot executions (simplified).

list (optional)

array[CompletedBotExecutionItem]

`CompletedBotExecutionsRequest` Up

Request to list completed bot executions within a time range (no paging; bounded by size).

timeRange (optional)

TimeRange

size (optional)

Integer Maximum number of completed executions to return.

example: 100

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`Execution` Up

id (optional)

String Unique execution id

example: 972f41ee-90e7-4a62-8d1-055dc9c3b59c_668b1db6649c43da

automationName (optional)

String Name of the automation to which the execution is associated

example: testbot.2022.04.13.22.22.50.john_creator

fileName (optional)

String Name of the automation that is deployed to execute

example: testbot

type (optional)

String Old Activity Type (deprecated in favor of activityType & initiationType) <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 - Automation export</li> <li>API - An automation that is run from an API</li> <li>AARI - A process bot</li> <li>RUN_NOW - A regular run as a users automation</li> <li>SCHEDULED - A scheduled automation</li> <li>TRIGGER - A triggered automation</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: TRIGGER

startDateTime (optional)

String Date and time when the execution started

example: 2022-04-14T06:39:24.254386346Z

endDateTime (optional)

String Date and time when the execution ended

example: 2022-04-14T06:39:27.438843100Z

command (optional)

String Current command of the execution

example: messageBox

status (optional)

String Current status of the execution <li>COMPLETED - Automation successfully completed execution</li> <li>DEPLOYED - Autologin is successful, and automation is deployed to a device</li> <li>DEPLOY_FAILED - Automation failed to deploy to the device because, for example, autologin failed</li> <li>QUEUED - Requested user or device is busy running another execution</li> <li>PENDING_EXECUTION - Device has been selected, but automation has not yet been deployed to that device</li> <li>RUNNING - Automation started execution</li> <li>UPDATE - Automation is in progress</li> <li>RUN_FAILED - Automation failed after being deployed to a device</li> <li>RUN_PAUSED - User paused the automation</li> <li>RUN_ABORTED - User aborted the automation</li> <li>RUN_TIMED_OUT - Automation failed to complete tasks within a specific time period</li> <li>UNKNOWN - Connection between the service and the device was lost</li> </ul>

Enum:

COMPLETED

DEPLOYED

RUNNING

RUN_PAUSED

UNKNOWN

RUN_FAILED

RUN_ABORTED

RUN_TIMED_OUT

DEPLOY_FAILED

QUEUED

UPDATE

PENDING_EXECUTION

progress (optional)

Integer Current progress of the execution in percentage

example: 100

automationId (optional)

String Schedule id of the automation

userId (optional)

String Corresponding User id of the device where the automation is deployed

example: 1

deviceId (optional)

String Device id where the automation is deployed

example: 1

currentLine (optional)

Integer Current line of automation that is deployed to execute

example: 1

totalLines (optional)

Integer Total lines of the automation that is deployed to execute

example: 1

fileId (optional)

String Id of the automation that is deployed to execute

example: 1

modifiedBy (optional)

String Id of the user who last updated the execution

example: john_creator

createdBy (optional)

String Id of the user who created the automation associated with the execution

example: john_creator

modifiedOn (optional)

String Date and time when the execution was last updated

example: 2022-04-14T06:35:24.773187700Z

createdOn (optional)

String Date and time when the execution was created

example: 2022-04-14T06:36:25.873480700Z

deploymentId (optional)

String Deployment id to which the execution is associated

example: 494562cb-7c24-41d2-ae0e-8b8c5084ae90

queueName (optional)

String Queue name (deprecated)

queueId (optional)

String Queue id (deprecated)

usingRdp (optional)

Boolean A flag that shows whether or not the automation is using remote deployment protocol

message (optional)

String Error message that describes the state of the execution

canManage (optional)

Boolean A flag that shows if the current logged in user has rights to manage the execution

deviceName (optional)

String The name of the device the automation is designated to run on

example: AAUS34NS3RM

userName (optional)

String The username of the user the automation is designated to run from

example: john_unattended

tenantUuid (optional)

String The UUID code of the tenant the automation is being run from

example: e135e92d-27dd-405e-bc52-b8fad270476f

automationPriority (optional)

String The automation priority used when it is in queue

Enum:

PRIORITY_LOW

PRIORITY_MEDIUM

PRIORITY_HIGH

runElevated (optional)

Boolean A flag showing whether the automation deployed using elevated permissions or not

example: false

botLabel (optional)

String Label for the automation. It can be used to distinguish automations from categories like production and testing

example: PRODUCTION

currentBotName (optional)

String The automation's current bot name. It can change during the execution

example: testbot

callbackInfo (optional)

String No value is returned for this parameter in the list API. Use the fetch execution API with specific id to retrieve that information

parentId (optional)

String Only returned for child executions that are spawned by a parent execution. Will be the same as the parent execution's unique ID.

example: 8f1d7270-3ca7-4c51-b412-2c214c6550cf

initiationType (optional)

String Initiation type for the activity. <ul> <li>API - Activity initiated by API or backend.</li> <li>RUN_NOW - Activity initiated from Run Now option.</li> <li>SCHEDULED -Activity initiated from schedule.</li> <li>TRIGGER - Activity initiated by trigger.</li> <li>EXPORT - Activity initiated by an export of data.</li> <li>IMPORT - Activity initiated by an import of data.</li> <li>AARI - Activity initiated by Automation Anywhere Robotic Interface (AARI).</li> <li>WLM - Activity initiation by Workload Management (WLM).</li> <li>MIGRATION - Activity created by internal migration.</li> <li>CREATOR - Activity run from the bot creator editor page.</li> <li>DEBUG - Activity run from the debug mode of the bot creator editor page.</li> <li>RECORDER - Activity initiated by bot recorder.</li> </ul>

Enum:

API

RUN_NOW

SCHEDULED

TRIGGER

EXPORT

IMPORT

AARI

WLM

MIGRATION

CREATOR

DEBUG

RECORDER

example: TRIGGER

activityType (optional)

String The type of activity. <ul> <li>BOT - Bot for robotic process automation.</li> <li>AUDIT_EXPORT - Export of a csv of Control Room audit logs.</li> <li>QUEUE_EXPORT - Export of a queue from workload management (WLM) in zip format.</li> <li>QUEUE_IMPORT - Import of a queue from workload management (WLM).</li> <li>WORKITEM_EXPORT - Export of a work item from workload management (WLM) in CSV format.</li> <li>ROLE_EXPORT - Export of assigned user and runasuser to a CSV file.</li> <li>BLM_EXPORT - Export of a single bot with its dependent files.</li> </ul>

Enum:

BOT

AUDIT_EXPORT

QUEUE_EXPORT

QUEUE_IMPORT

WORKITEM_EXPORT

BLM_EXPORT

ROLE_EXPORT

WORK_ORDER

PROCESS

FORM

APPROVAL

DOCUMENT_VALIDATION

TASK_PROCESS

TASK_APPROVAL

TASK_DOCUMENT_VALIDATION

TASK_BOT

TASK_API

API_TASK

example: BOT

refId (optional)

String Reference id only for process related executions.

example: 4-0

`ExecutionResponse` Up

page (optional)

PageResponse

list (optional)

array[Execution] list of automation executions.

`FailedBotExecutionItem` Up

Simplified failed bot execution.

botId (optional)

String Bot identifier

name (optional)

String Bot name

path (optional)

String Repository path of the bot

startDateTime (optional)

Date Start time of the execution format: date-time

id (optional)

String Unique execution id

failureReason (optional)

String Failure reason / message

`FailedBotExecutionListResponse` Up

List of failed bot executions (simplified).

list (optional)

array[FailedBotExecutionItem]

`FailedBotExecutionsRequest` Up

Request to list failed bot executions within a time range (no paging; bounded by size).

timeRange (optional)

TimeRange

size (optional)

Integer Maximum number of failed executions to return.

example: 100

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[Filter]

field (optional)

String Filter field could be either name,lastModified,path or directory.

value (optional)

String Filter value

`PageRequest` Up

Pagination rules

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 1

`PageResponse` Up

Pagination response

offset (optional)

Integer Page starting index

example: 0

total (optional)

Integer Total number of items

example: 2

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

direction (optional)

String Sorting direction

Enum:

asc

desc

`TimeRange` Up

type (optional)

String The period of time for the requested activity metrics <ul> <li>CUSTOM - Specify a custom start (from) and end (to) date and time.</li> <li>LAST24HOURS - The last twenty‑four hours.</li> <li>LAST7DAYS - The last seven full days (rolling window).</li> <li>LAST30DAYS - The last thirty full days (rolling window).</li> <li>LAST60DAYS - The last sixty full days (rolling window).</li> <li>LAST90DAYS - The last ninety full days (rolling window).</li> </ul>