Skip to main content
GET
/
process-definition
/
statistics
Get Process Instance Statistics
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/statistics \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "@class": "org.camunda.bpm.engine.rest.dto.repository.ProcessDefinitionStatisticsResultDto",
    "id": "aProcessDefinitionId",
    "instances": 123,
    "failedJobs": 42,
    "definition": {
      "id": "aProcessDefinitionId",
      "key": "aKey",
      "category": null,
      "description": null,
      "name": "aName",
      "version": 0,
      "resource": null,
      "deploymentId": null,
      "diagram": null,
      "suspended": false,
      "tenantId": null,
      "versionTag": "1.0.0",
      "historyTimeToLive": null,
      "startableInTasklist": false
    },
    "incidents": []
  },
  {
    "@class": "org.camunda.bpm.engine.rest.dto.repository.ProcessDefinitionStatisticsResultDto",
    "id": "aProcessDefinitionId:2",
    "instances": 124,
    "failedJobs": 43,
    "definition": {
      "id": "aProcessDefinitionId:2",
      "key": "aKey",
      "category": null,
      "description": null,
      "name": "aName",
      "version": 0,
      "resource": null,
      "deploymentId": null,
      "diagram": null,
      "suspended": false,
      "tenantId": null,
      "versionTag": null,
      "historyTimeToLive": null,
      "startableInTasklist": false
    },
    "incidents": []
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
failedJobs
boolean

Whether to include the number of failed jobs in the result or not. Valid values are true or false.

​
incidents
boolean

Valid values for this property are true or false. If this property has been set to true the result will include the corresponding number of incidents for each occurred incident type. If it is set to false, the incidents will not be included in the result. Cannot be used in combination with incidentsForType.

​
incidentsForType
string

If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with incidents. See the User Guide for a list of incident types.

​
rootIncidents
boolean

Valid values for this property are true or false. If this property has been set to true the result will include the corresponding number of root incidents for each occurred incident type. If it is set to false, the incidents will not be included in the result. Cannot be used in combination with incidentsForType or incidents.

Response

Request successful.

​
id
string | null

The id of the process definition the results are aggregated for.

​
instances
integer

The total number of running process instances of this process definition.

​
failedJobs
integer

The total number of failed jobs for the running instances. Note: Will be 0 (not null), if failed jobs were excluded.

​
incidents
object[] | null

Each item in the resulting array is an object which contains incidentType and incidentCount. Note: Will be an empty array, if incidents or incidentsForType were excluded. Furthermore, the array will be also empty if no incidents were found.

​
@class
string | null

The fully qualified class name of the data transfer object class. The class name might change in future releases.

​
definition
object