Skip to main content
GET
/
metrics
Get Metrics in Interval
curl --request GET \
  --url http://{host}:{port}/{contextPath}/metrics \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "timestamp": "1970-01-01T01:45:00.000+0200",
    "name": "flow-node-instances",
    "reporter": "REPORTER",
    "value": 23
  }
]

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

​
name
enum<string>

The name of the metric.

Available options:
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
​
reporter
string

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

​
startDate
string<date-time>

The start date (inclusive).

​
endDate
string<date-time>

The end date (exclusive).

​
firstResult
integer

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

​
maxResults
integer

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

​
interval
string
default:900

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

​
aggregateByReporter
string

Aggregate metrics by reporter.

Response

Request successful.

​
timestamp
string<date-time> | null

The interval timestamp.

​
name
string | null

The name of the metric.

​
reporter
string | null

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

​
value
integer | null

The value of the metric aggregated by the interval.