Skip to main content
Version: 8.9 (unreleased)

Type Alias: GetUsageMetricsData

type GetUsageMetricsData = object;

Defined in: gen/types.gen.ts:15472

Properties

body?

optional body: never;

Defined in: gen/types.gen.ts:15473


path?

optional path: never;

Defined in: gen/types.gen.ts:15474


query

query: object;

Defined in: gen/types.gen.ts:15475

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";

Defined in: gen/types.gen.ts:15493