Overview Statistics API

Overview Statistics API

The Overview Statistics API provides aggregated metrics and time-series data for process instances. All endpoints support filtering by process, version, and date range.

Base Path: /overview

Endpoints

Instance Count Endpoints

These endpoints return aggregate counts and statistics as single values (Integer, Long, or Double).

GET /overview/started-instances

Returns the total count of process instances that were started within the specified date range.

Response Type: Integer

Example Request:

GET /overview/started-instances?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters:

Parameter Type Required Description
processKey string No Process definition key
version string No Process version
startDate string No Start date (ISO 8601)
endDate string No End date (ISO 8601)

Example Response:

142

GET /overview/finalized-instances

Returns the total count of process instances that were finalized (completed, canceled, or terminated) within the specified date range.

Response Type: Integer

Example Request:

GET /overview/finalized-instances?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

135

GET /overview/successful-instances

Returns the total count of process instances that completed successfully within the specified date range.

Response Type: Integer

Example Request:

GET /overview/successful-instances?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

128

GET /overview/avg-process-duration

Returns the average duration (in milliseconds) of process instances within the specified date range.

Response Type: Long

Example Request:

GET /overview/avg-process-duration?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

3600000

Note: The value is in milliseconds. In this example, 3,600,000ms = 1 hour.

GET /overview/canceled-instances-internally-terminated

Returns the count of process instances that were canceled due to internal termination within the specified date range.

Response Type: Integer

Example Request:

GET /overview/canceled-instances-internally-terminated?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

3

GET /overview/canceled-instances-externally-terminated

Returns the count of process instances that were canceled due to external termination within the specified date range.

Response Type: Integer

Example Request:

GET /overview/canceled-instances-externally-terminated?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

4

GET /overview/error-start-event-instances

Returns the count of process instances that were triggered by error start events within the specified date range.

Response Type: Integer

Example Request:

GET /overview/error-start-event-instances?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

7

GET /overview/incident-instances

Returns the count of process instances that had incidents within the specified date range.

Response Type: Integer

Example Request:

GET /overview/incident-instances?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

5

User Task Endpoints

These endpoints provide statistics related to user tasks within process instances.

GET /overview/completed-user-tasks-percentage

Returns the percentage of user tasks that were completed within the specified date range.

Response Type: Double

Example Request:

GET /overview/completed-user-tasks-percentage?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

94.5

Note: The value is a percentage (0-100). In this example, 94.5% of user tasks were completed.

GET /overview/avg-user-task-duration

Returns the average duration (in milliseconds) of user tasks within the specified date range.

Response Type: Long

Example Request:

GET /overview/avg-user-task-duration?processKey=order-process&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z

Parameters: Same as /overview/started-instances

Example Response:

7200000

Note: The value is in milliseconds. In this example, 7,200,000ms = 2 hours.

GET /overview/graph/started-instances

Returns time-series data for started process instances.

Purpose: Get historical data showing when process instances were started, grouped by time intervals.

Parameters:

Parameter Type Required Description
processKey string No Process definition key
version string No Process version
startDate string No Start date (ISO 8601)
endDate string No End date (ISO 8601)

Response Example:

[
  {
    "date": 1704067200000,
    "totalInstances": 45
  },
  {
    "date": 1704153600000,
    "totalInstances": 52
  },
  {
    "date": 1704240000000,
    "totalInstances": 38
  }
]

Response Fields:

Field Type Description
date long Timestamp in milliseconds (Unix epoch)
totalInstances int Number of instances started at this time

GET /overview/graph/finalized-instances

Returns time-series data for finalized process instances.

Purpose: Get historical data showing when process instances were completed or terminated.

Parameters: Same as /overview/graph/started-instances

Response Example:

[
  {
    "date": 1704067200000,
    "totalInstances": 42
  },
  {
    "date": 1704153600000,
    "totalInstances": 48
  }
]

GET /overview/graph/successful-instances

Returns time-series data for successfully completed process instances.

Purpose: Track process instances that completed without errors or cancellations.

Parameters: Same as /overview/graph/started-instances

Response Example:

[
  {
    "date": 1704067200000,
    "totalInstances": 40
  },
  {
    "date": 1704153600000,
    "totalInstances": 45
  }
]

GET /overview/graph/canceled-instances

Returns time-series data for canceled process instances.

Purpose: Track process instances that were canceled (internally or externally).

Parameters: Same as /overview/graph/started-instances

Response Example:

[
  {
    "date": 1704067200000,
    "totalInstances": 2
  },
  {
    "date": 1704153600000,
    "totalInstances": 3
  }
]

GET /overview/graph/incident-instances

Returns time-series data for process instances with incidents.

Purpose: Track process instances that encountered errors or incidents.

Parameters: Same as /overview/graph/started-instances

Response Example:

[
  {
    "date": 1704067200000,
    "totalInstances": 1
  },
  {
    "date": 1704153600000,
    "totalInstances": 2
  }
]

Usage Examples

Get Overall Statistics

curl -X GET "http://localhost:8899/overview"

Get Statistics for a Specific Process

curl -X GET "http://localhost:8899/overview?processKey=invoice-process&version=1"

Get Statistics for a Date Range

curl -X GET "http://localhost:8899/overview?processKey=invoice-process&version=1&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z"

Get Started Instances Time Series

curl -X GET "http://localhost:8899/overview/graph/started-instances?processKey=invoice-process&version=1&startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z"

Notes

  • All time values are in milliseconds
  • Date parameters must be in ISO 8601 format with timezone
  • Omitting processKey and version returns aggregated data for all processes
  • The version parameter requires processKey to be specified
  • Time-series data is aggregated by time intervals (typically daily)

On this Page: