Skip to main content
Version: 8.9

Type Alias: GetUsageMetricsData

type GetUsageMetricsData = object;

Properties​

body?​

optional body?: never;

path?​

optional path?: never;

query​

query: object;

endTime​

endTime: string;

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

startTime​

startTime: string;

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

tenantId?​

optional tenantId?: TenantId;

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

withTenants?​

optional withTenants?: boolean;

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

url​

url: "/system/usage-metrics";