ProcessInstances
Agent Group where Process Instances should be fetched from
Filter by Processes
Filter by Execution start time
Filter by Execution end time
Filter by Execution state
Filter by whether process is a child process (i.e. a subprocess, if not started manually)
If there are more results to be shown a continuationToken will be needed to show the next set of results. This token is passed as nextContinuationToken in the result of the previous query. Warning! If any filters except continuationToken are changed between requests the results will be invalid
Maximum page size is 200. Default page size is 50
50Success
Agent group not found
GET /api/v1/instances/{agentGroupId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 1,
"parentId": 1,
"processId": 1,
"rootProcessId": 1,
"processVersion": 1,
"state": "Ok",
"startTimeUtc": "2025-09-07T10:03:58.639Z",
"endTimeUtc": "2025-09-07T10:03:58.639Z",
"utcDate": "2025-09-07T10:03:58.639Z",
"utcHour": 1,
"executionId": "123e4567-e89b-12d3-a456-426614174000",
"triggerId": 1,
"agentId": 1,
"environmentId": 1,
"agentGroupId": 1,
"exception": "text",
"userName": "text",
"stepsLoggedToBlobs": true,
"hasLoggedSteps": true,
"acknowledgedUtc": "2025-09-07T10:03:58.639Z",
"commentJson": "text",
"comment": "text",
"promotedData": [
{
"id": 1,
"processExecutionId": "123e4567-e89b-12d3-a456-426614174000",
"timeStamp": "2025-09-07T10:03:58.639Z",
"environmentName": "text",
"promotedVariableName": "text",
"promotedValueJson": "text"
}
],
"triggerName": "text",
"environmentName": "text",
"agentName": "text",
"processGuid": "123e4567-e89b-12d3-a456-426614174000",
"parentName": "text",
"triggerRequest": [
[
[
"[Circular Reference]"
]
]
],
"triggerResponses": [
[
[
"[Circular Reference]"
]
]
],
"promotedColumns": [
{
"name": "text",
"value": [
"[Circular Reference]"
]
}
]
}
],
"nextContinuationToken": "text",
"nextLink": {
"uri": "https://example.com",
"method": "text"
}
}Agent Group where Process Instance should be fetched from
Execution identifier of the Process Instance
Success
Process Instance not found
GET /api/v1/instances/{agentGroupId}/{executionIdentifier}/details HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 1,
"parentId": 1,
"parentName": "text",
"executionId": "123e4567-e89b-12d3-a456-426614174000",
"processGuid": "123e4567-e89b-12d3-a456-426614174000",
"rootProcessGuid": "123e4567-e89b-12d3-a456-426614174000",
"processVersion": 1,
"state": "Ok",
"steps": [
{
"id": 1,
"state": "Ok",
"stepId": "text",
"loopParameters": [
[
"[Circular Reference]"
]
]
}
],
"stepDataUri": "text",
"startTimeUtc": "2025-09-07T10:03:58.639Z",
"endTimeUtc": "2025-09-07T10:03:58.639Z",
"duration": {
"ticks": 1,
"days": 1,
"hours": 1,
"milliseconds": 1,
"microseconds": 1,
"nanoseconds": 1,
"minutes": 1,
"seconds": 1,
"totalDays": 1,
"totalHours": 1,
"totalMilliseconds": 1,
"totalMicroseconds": 1,
"totalNanoseconds": 1,
"totalMinutes": 1,
"totalSeconds": 1
},
"environment": "text",
"agentGroup": "text",
"agent": "text",
"exception": "text",
"userName": "text",
"triggerName": "text",
"processParameters": [
[
[
[
"[Circular Reference]"
]
]
]
],
"processReturnValues": [
[
[
[
"[Circular Reference]"
]
]
]
],
"hasLoggedSteps": true
}
}The unique identifiers of the Processes to get the counts for.
The start time of the execution of the Processes to get the counts for.
The end time of the execution of the Processes to get the counts for.
Groups counts by hour instead of by date.
Limit counts by days
The filtered Process instance counts
Agent group not found
GET /api/v1/instances/counts/{agentGroupId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"executionCounts": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {
"running": 1,
"latestRunning": "2025-09-07T10:03:58.639Z",
"successful": 1,
"latestSuccessful": "2025-09-07T10:03:58.639Z",
"failed": 1,
"latestFailed": "2025-09-07T10:03:58.639Z",
"erroredNotAcknowledged": 1,
"latestExecutionState": "Ok"
}
}
}
}
}
}Acknowledges errors of specified instances of the specified Process in the specified Agent Group.
Operation was successful.
No content
No Agent Group ID provided.
Could not find Agent Group with the specified ID.
POST /api/v1/instances/{agentGroupId}/{processGuid}/acknowledge HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"reason": "text",
"instanceIds": [
1
]
}No content
GUID of the Process.
Operation was successful.
No content
No Agent Group name provided.
Could not find Agent Group with the specified ID.
POST /api/v1/instances/{agentGroupId}/{processGuid}/comment HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"comment": "text",
"processGuids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"instanceIds": [
1
]
}No content
Downloads CSV-exported data of Process instances of a specified Process in a specified Agent Group, from a specified timespan.
IDs of the Process instances. If unspecified, the operation will return 10000 instances.
CSV file download.
No Agent Group name provided.
Could not find Agent Group with the specified ID.
GET /api/v1/instances/{agentGroupId}/{processGuid}/export HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
binaryOperation was successful.
No content
No Agent Group name provided.
Could not find Agent Group with the specified ID.
POST /api/v1/instances/{agentGroupId}/{processGuid}/delete HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3
[
1
]No content
Was this helpful?