Sign in
Metrics

Get Metrics in Interval

Retrieves a list of metrics, aggregated for a given interval.

get/metrics

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/metrics
  • Auth: HTTP basic

Query parameters

name'activity-instance-start' | 'activity-instance-end' | 'decision-instances' | 'flow-node-instances' | 'job-acquisition-attempt' | 'job-acquired-success' | 'job-acquired-failure' | 'job-execution-rejected' | 'job-successful' | 'job-failed' | 'job-locked-exclusive' | 'executed-decision-elements' | 'history-cleanup-removed-process-instances' | 'history-cleanup-removed-case-instances' | 'history-cleanup-removed-decision-instances' | 'history-cleanup-removed-batch-operations' | 'history-cleanup-removed-task-metrics' | 'process-instances'

The name of the metric.

reporterstring

The name of the reporter (host), on which the metrics was logged. This will have value provided by the hostname configuration property.

startDatestring date-time

The start date (inclusive).

endDatestring date-time

The end date (exclusive).

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

intervalinteger

The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds).

aggregateByReporterstring

Aggregate metrics by reporter.

Response

Request successful.

timestampstring date-time nullable

The interval timestamp.

namestring nullable

The name of the metric.

reporterstring nullable

The reporter of the metric. null if the metrics are aggregated by reporter.

valueinteger nullable

The value of the metric aggregated by the interval.

Changes

No recorded changes to this operation across all 1 revision of this API.