@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias GetUsageMetricsData

    type GetUsageMetricsData = {
        body?: never;
        path?: never;
        query: {
            endTime: string;
            startTime: string;
            tenantId?: TenantId;
            withTenants?: boolean;
        };
        url: "/system/usage-metrics";
    }
    Index

    Properties

    body? path? query url

    Properties

    Optionalbody

    body?: never
    path?: never
    query: {
        endTime: string;
        startTime: string;
        tenantId?: TenantId;
        withTenants?: boolean;
    }

    Type Declaration

    • endTime: string

      The end date for usage metrics, including this date. Value in ISO 8601 format.

    • startTime: string

      The start date for usage metrics, including this date. Value in ISO 8601 format.

    • OptionaltenantId?: TenantId

      Restrict results to a specific tenant ID. If not provided, results for all tenants are returned.

    • OptionalwithTenants?: boolean

      Whether to return tenant metrics in addition to the total metrics or not. Default false.

    url: "/system/usage-metrics"

    Settings

    Member Visibility

    On This Page

    Properties