Get usage metrics for clusters

GET 
http://localhost:8080/admin-api/usage-metrics

Returns usage metrics for a specific cluster for a given time range. The usage metrics are aggregated over the time range and include number of started process instances, executed decision instances, and assigned task users.

Request

Query Parameters

id stringrequired

The unique identifier of the cluster

start doublerequired

The start timestamp of the time range as UNIX timestamp in milliseconds

end doublerequired

The end timestamp of the time range as UNIX timestamp in milliseconds

Responses

200

Ok

application/json

Schema

Schema

idstringrequired

The identifier of the cluster.

processInstances objectrequired

The usage metrics for started process instances.

totaldoublerequired

The number of usage metrics for a specific type.

decisionInstances objectrequired

The usage metrics for executed decision instances.

totaldoublerequired

The number of usage metrics for a specific type.

taskUsers objectrequired

The usage metrics for assigned task users.

totaldoublerequired

The number of usage metrics for a specific type.

assigneesstring[]required

The users that tasks have been assigned to.

Example (auto)

{
  "id": "string",
  "processInstances": {
    "total": 0
  },
  "decisionInstances": {
    "total": 0
  },
  "taskUsers": {
    "total": 0,
    "assignees": [
      "string"
    ]
  }
}

403

Forbidden

500

Server-side error

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• java
• nodejs
• csharp
• python
• go

• CURL

curl -L 'http://localhost:8080/admin-api/usage-metrics' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

http://localhost:8080

Auth

Bearer Token

Parameters

id — queryrequired

start — queryrequired

end — queryrequired