[GET] /reports/{id}

[GET] /reports/{id}

/api/bpm/statistics/reports/{id}

Description

To retrieve detailed information about a statistical report by its ID.

The report contains metadata such as the report id, name, creation timestamp, and information about the user who generated it. Reports can be of two types: PROCESS_STATISTICS, which includes aggregated statistics for families and tasks, and PROCESS_DETAILS, which provides detailed information about each process and its associated tasks without aggregated statistics.

The data returned by the endpoint depends on the configuration of the entire report.

If an attribute is missing, it is considered null and is not included in the JSON response.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Response
Format

JSON

Minimum Version

1.4.0

Request
Example

/api/bpm/statistics/reports/6B35EC18F1704D21B2DBB1F879DE0DD9

Result Example for PROCESS_STATISTICS

{ "id": "D4AEF0E4BE884F34A04F76CE92D0A86C", "name": "Report 1", "createTime": "2026-01-06T20:41:19+01:00", "userId": "BF894230A0324FB887CDD732FCDDD61D", "userName": "ROOT", "statistics": { "numberOfProcesses": 269, "numberOfProcessesError": 156, "numberOfProcessesPause": 3, "numberOfActivities": 644, "numberOfActivitiesFinished": 315, "numberOfActivitiesUnfinished": 329, "numberOfActivitiesPersonalized": 76, "numberOfActivitiesError": 156, "numberOfActivitiesPause": 3, "minProcessRunTime": 641535, "meanProcessRunTime": 48324779, "maxProcessRunTime": 192948551, "minActivityRunTime": 14625939, "meanActivityRunTime": 28326171, "maxActivityRunTime": 192947920, "minActivityRunTimeFinished": 0, "meanActivityRunTimeFinished": 1362734, "maxActivityRunTimeFinished": 134847551, "minActivityRunTimeUnfinished": 14625939, "meanActivityRunTimeUnfinished": 54142241, "maxActivityRunTimeUnfinished": 192947920, "minActivityRunTimePersonalized": 128645, "meanActivityRunTimePersonalized": 127964673, "maxActivityRunTimePersonalized": 192947920, "numberOfEscalationsProcess": 12, "numberOfEscalationsActivity": 21, "numberOfEscalationsActivityFinished": 4, "numberOfEscalationsActivityUnfinished": 17, "numberOfEscalationsActivityPersonalized": 2 }, "families": [ { "id": "F9D444A9FE424FD8BC71AC03DDD47CE3", "name": "BPM Test Timer", "statistics": { "numberOfProcesses": 1, "numberOfProcessesError": 0, "numberOfProcessesPause": 1, "numberOfActivities": 2, "numberOfActivitiesFinished": 1, "numberOfActivitiesUnfinished": 1, "numberOfActivitiesPersonalized": 0, "numberOfActivitiesError": 0, "numberOfActivitiesPause": 1, "minProcessRunTime": 14625941, "meanProcessRunTime": 14625941, "maxProcessRunTime": 14625941, "minActivityRunTime": 14625939, "meanActivityRunTime": 7312969, "maxActivityRunTime": 14625939, "minActivityRunTimeFinished": 0, "meanActivityRunTimeFinished": 0, "maxActivityRunTimeFinished": 0, "minActivityRunTimeUnfinished": 14625939, "meanActivityRunTimeUnfinished": 14625939, "maxActivityRunTimeUnfinished": 14625939, "minActivityRunTimePersonalized": 0, "meanActivityRunTimePersonalized": 0, "maxActivityRunTimePersonalized": 0, "numberOfEscalationsProcess": 1, "numberOfEscalationsActivity": 1, "numberOfEscalationsActivityFinished": 0, "numberOfEscalationsActivityUnfinished": 1, "numberOfEscalationsActivityPersonalized": 0 }, "tasks": [ { "id": "971C358FF5A44B4CB11415096CDA8FFF", "name": "Activity 001", "statistics": { "numberOfActivities": 1, "numberOfActivitiesFinished": 0, "numberOfActivitiesUnfinished": 1, "numberOfActivitiesPersonalized": 0, "numberOfActivitiesError": 0, "numberOfActivitiesPause": 1, "minActivityRunTime": 14625939, "meanActivityRunTime": 14625939, "maxActivityRunTime": 14625939, "minActivityRunTimeFinished": 0, "meanActivityRunTimeFinished": 0, "maxActivityRunTimeFinished": 0, "minActivityRunTimeUnfinished": 14625939, "meanActivityRunTimeUnfinished": 14625939, "maxActivityRunTimeUnfinished": 14625939, "minActivityRunTimePersonalized": 0, "meanActivityRunTimePersonalized": 0, "maxActivityRunTimePersonalized": 0, "numberOfEscalationsActivity": 1, "numberOfEscalationsActivityFinished": 0, "numberOfEscalationsActivityUnfinished": 1, "numberOfEscalationsActivityPersonalized": 0 } }] }] }

Result
Example for PROCESS_DETAILS

{ "id": "64E37B47BB354A3393D1839F9C1D85E9", "name": "Report 1", "createTime": "2026-01-06T20:37:19+01:00", "userId": "BF894230A0324FB887CDD732FCDDD61D", "userName": "ROOT", "processes": [ { "id": "AEC3BA7F41B747B8BAF0C874374A9465", "name": "ExtremAdhoc 16", "subject": "", "startTime": "2021-05-20T12:09:33+02:00", "runTime": 146222866, "processDefinition": { "id": "1D3F4694BF1B4056B8A9DF75CE36006C", "name": "ExtremAdhoc" }, "statistics": { "numberOfActivities": 3, "numberOfActivitiesFinished": 1, "numberOfActivitiesUnfinished": 2, "numberOfActivitiesPersonalized": 1, "numberOfActivitiesError": 0, "numberOfActivitiesPause": 0, "numberOfEscalationsProcess": 0, "numberOfEscalationsActivity": 0, "numberOfEscalationsActivityFinished": 0, "numberOfEscalationsActivityUnfinished": 0, "numberOfEscalationsActivityPersonalized": 0 }, "tasks": [ { "id": "45200F982DA14E0694023A4D29C74BA6", "name": "Ad hoc activity", "state": "adHocExecuted", "startTime": "2021-05-20T12:09:35+02:00", "runTime": 146222864, "escalations": 0, "processDefinition": { "id": "931E96E300AA4F5086EFC46602013274" } }] }] }

Response codes

  • 200 - Success: Report data successfully returned.

  • 400 - Returned when the ID is in an invalid format.

  • 404 - Returned when the ID doesn’t exist.

  • 403 - If the user does not have the required role.