Skip to main content
GET
/
history
/
process-definition
/
{id}
/
statistics
Get Historic Activity Statistics
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/process-definition/{id}/statistics \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "anActivity",
    "instances": 123,
    "canceled": 50,
    "finished": 0,
    "completeScope": 0,
    "openIncidents": 0,
    "resolvedIncidents": 0,
    "deletedIncidents": 0
  },
  {
    "id": "anotherActivity",
    "instances": 200,
    "canceled": 150,
    "finished": 0,
    "completeScope": 0,
    "openIncidents": 0,
    "resolvedIncidents": 0,
    "deletedIncidents": 0
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process definition.

Query Parameters

​
canceled
boolean

Whether to include the number of canceled activity instances in the result or not. Valid values are true or false. Default: false.

​
finished
boolean

Whether to include the number of finished activity instances in the result or not. Valid values are true or false. Default: false.

​
completeScope
boolean

Whether to include the number of activity instances which completed a scope in the result or not. Valid values are true or false. Default: false.

​
incidents
boolean

Whether to include the number of incidents. Valid values are true or false. Default: false.

​
startedBefore
string<date-time>

Restrict to process instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
startedAfter
string<date-time>

Restrict to process instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
finishedBefore
string<date-time>

Restrict to process instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
finishedAfter
string<date-time>

Restrict to process instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
processInstanceIdIn
string

Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list.

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
activityId
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc

Response

Request successful.

​
id
string | null

The id of the activity the results are aggregated for.

​
instances
integer | null

The total number of all running instances of the activity.

​
canceled
integer | null

The total number of all canceled instances of the activity. Note: Will be 0 (not null), if canceled activity instances were excluded.

​
finished
integer | null

The total number of all finished instances of the activity. Note: Will be 0 (not null), if finished activity instances were excluded.

​
completeScope
integer | null

The total number of all instances which completed a scope of the activity. Note: Will be 0 (not null), if activity instances which completed a scope were excluded.

​
openIncidents
integer | null

The total number of open incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.

​
resolvedIncidents
integer | null

The total number of resolved incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.

​
deletedIncidents
integer | null

The total number of deleted incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.