Skip to main content
Version: Next

Get usage metrics for clusters

GET 
/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​

Ok

Schema
    id stringrequired

    The identifier of the cluster.

    processInstances objectrequired

    The usage metrics for started process instances.

    total doublerequired

    The number of usage metrics for a specific type.

    decisionInstances objectrequired

    The usage metrics for executed decision instances.

    total doublerequired

    The number of usage metrics for a specific type.

    taskUsers objectrequired

    The usage metrics for assigned task users.

    total doublerequired

    The number of usage metrics for a specific type.

    assignees string[]required

    The users that tasks have been assigned to.

Loading...