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

Method

GET /metrics

Parameters

Query Parameters

Name	Description
name	The name of the metric. Supported names: activity-instance-start, activity-instance-end, job-acquisition-attempt, job-acquired-success, job-acquired-failure, job-execution-rejected, job-successful, job-failed, job-locked-exclusive, executed-decision-elements, executed-decision-instances, 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, root-process-instance-start
reporter	The name of the reporter (host), on which the metrics was logged. This will have value provided by the configuration property.
startDate	The start date (inclusive).
endDate	The end date (exclusive).
firstResult	The index of the first result, used for paging.
maxResults	The maximum result size of the list which should be returned. The maxResults can't be set larger than 200. Default: 200
interval	The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds).
aggregateByReporter	Aggregate metrics by reporter.

Result

A JSON array of aggregated metrics. Each aggregated metric has the following properties:

Name	Value	Description
timestamp	Date	The interval timestamp.
name	String	The name of the metric.
reporter	String	The reporter of the metric. null if the metrics are aggregated by reporter.
value	Number	The value of the metric aggregated by the interval.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid.

Example

Request

GET /metrics?name=activity-instance-end&startDate=1970-01-01T01:45:00.000%2b0200&endDate=1970-01-01T02:00:00.000%2b0200

Response

[
  {
    "timestamp":"1970-01-01T01:45:00.000+0200",
    "name":"activity-instance-end",
    "reporter":"REPORTER",
    "value":23
  }
]