Skip to main content
GET
/
history
/
process-instance
/
report
Get Duration Report
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/process-instance/report \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "period": 1,
    "periodUnit": "QUARTER",
    "maximum": 500000,
    "minimum": 250000,
    "average": 375000
  },
  {
    "period": 2,
    "periodUnit": "QUARTER",
    "maximum": 600000,
    "minimum": 300000,
    "average": 450000
  },
  {
    "period": 3,
    "periodUnit": "QUARTER",
    "maximum": 1000000,
    "minimum": 500000,
    "average": 750000
  },
  {
    "period": 4,
    "periodUnit": "QUARTER",
    "maximum": 200000,
    "minimum": 100000,
    "average": 150000
  }
]

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

​
reportType
string
required

Mandatory. Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to duration.

​
periodUnit
enum<string>
required

Mandatory. Specifies the granularity of the report. Valid values are month and quarter.

Available options:
month,
quarter
​
processDefinitionIdIn
string

Filter by process definition ids. Must be a comma-separated list of process definition ids.

​
processDefinitionKeyIn
string

Filter by process definition keys. Must be a comma-separated list of process definition keys.

​
startedBefore
string<date-time>

Restrict to 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., 2016-01-23T14:42:45.000+0200.

​
startedAfter
string<date-time>

Restrict to 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., 2016-01-23T14:42:45.000+0200.

Response

Request successful.

​
period
integer<int32> | null

Specifies a timespan within a year. Note: The period must be interpreted in conjunction with the returned periodUnit.

​
periodUnit
enum<string> | null

The unit of the given period. Possible values are MONTH and QUARTER.

Available options:
MONTH,
QUARTER
​
minimum
integer<int64> | null

The smallest duration in milliseconds of all completed process instances which were started in the given period.

​
maximum
integer<int64> | null

The greatest duration in milliseconds of all completed process instances which were started in the given period.

​
average
integer<int64> | null

The average duration in milliseconds of all completed process instances which were started in the given period.