Returns a snapshot report of all current usage metrics, grouped by category/tier.
const url = 'https://example.com/api/v1/provision/admin/reports/usage-metrics';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/provision/admin/reports/usage-metricsResponses
Section titled “ Responses ”OK
Server-aggregated usage metrics report. Contains a flat list of metric entries, each tagged with its category/tier. The report is agnostic to which specific metrics are defined — new collectors automatically appear without DTO changes. Historical/time-series chart data should be queried separately via DataService.
object
A single metric value within a report.
object
Unique metric identifier, e.g. “entitlement.active.total”.
Human-readable display name, e.g. “Active Entitlements”.
What this metric measures.
Tier/category tag, e.g. “Active”, “Compliance”, “Growth”, “Adoption”.
Cross-cutting classification tags for secondary grouping/filtering.
Current snapshot value.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
When this metric value was sampled (UTC).
Associated entitlement ID, if the metric is scoped to one.
Display name of the associated entitlement.
Assigned plan set ID for the associated entitlement, when available.
Assigned plan name for the associated entitlement, when available.
Associated product ID, if the metric is scoped to one.
Display name of the associated product.
Server-aggregated usage metrics report. Contains a flat list of metric entries, each tagged with its category/tier. The report is agnostic to which specific metrics are defined — new collectors automatically appear without DTO changes. Historical/time-series chart data should be queried separately via DataService.
object
A single metric value within a report.
object
Unique metric identifier, e.g. “entitlement.active.total”.
Human-readable display name, e.g. “Active Entitlements”.
What this metric measures.
Tier/category tag, e.g. “Active”, “Compliance”, “Growth”, “Adoption”.
Cross-cutting classification tags for secondary grouping/filtering.
Current snapshot value.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
When this metric value was sampled (UTC).
Associated entitlement ID, if the metric is scoped to one.
Display name of the associated entitlement.
Assigned plan set ID for the associated entitlement, when available.
Assigned plan name for the associated entitlement, when available.
Associated product ID, if the metric is scoped to one.
Display name of the associated product.
Example generated
{ "generatedAtUtc": "2026-04-15T12:00:00Z", "metrics": [ { "metricName": "example", "name": "example", "description": "example", "category": "example", "tags": [ "example" ], "value": 1, "numberFormat": "example", "sampledAtUtc": "2026-04-15T12:00:00Z", "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entitlementName": "example", "assignedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "assignedPlanName": "example", "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "productName": "example" } ]}Server-aggregated usage metrics report. Contains a flat list of metric entries, each tagged with its category/tier. The report is agnostic to which specific metrics are defined — new collectors automatically appear without DTO changes. Historical/time-series chart data should be queried separately via DataService.
object
A single metric value within a report.
object
Unique metric identifier, e.g. “entitlement.active.total”.
Human-readable display name, e.g. “Active Entitlements”.
What this metric measures.
Tier/category tag, e.g. “Active”, “Compliance”, “Growth”, “Adoption”.
Cross-cutting classification tags for secondary grouping/filtering.
Current snapshot value.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
When this metric value was sampled (UTC).
Associated entitlement ID, if the metric is scoped to one.
Display name of the associated entitlement.
Assigned plan set ID for the associated entitlement, when available.
Assigned plan name for the associated entitlement, when available.
Associated product ID, if the metric is scoped to one.
Display name of the associated product.
Example generated
{ "generatedAtUtc": "2026-04-15T12:00:00Z", "metrics": [ { "metricName": "example", "name": "example", "description": "example", "category": "example", "tags": [ "example" ], "value": 1, "numberFormat": "example", "sampledAtUtc": "2026-04-15T12:00:00Z", "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entitlementName": "example", "assignedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "assignedPlanName": "example", "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "productName": "example" } ]}Unauthorized
object
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}