Returns a single metric's breakdown grouped by a dimension (product/customer/plan), sorted by value and limited to the top top rows. The grouping and top-N run server-side so the client never fetches the full metric snapshot. Pass top <= 0 to return every group.
const url = 'https://example.com/api/v1/provision/admin/reports/usage-metrics/breakdown';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-metrics/breakdownParameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Responses
Section titled “ Responses ”OK
Server-computed breakdown of a single metric grouped by a dimension (product / customer / plan), already sorted and limited to the top N rows. The grouping, sort and top-N happen server-side so the client never over-fetches the full snapshot just to render a small table.
object
The metric this breakdown is for, e.g. “api.requests.count”.
Dimension the rows are grouped by: “product”, “customer” or “plan”.
True when the metric carries per-entitlement/product attribution (i.e. a breakdown is meaningful).
Total number of distinct groups before the top-N limit (for the “showing top N of M” note).
Sum across all groups, used to compute each row’s share.
The top-N groups by value, highest first.
A single group within a UsageMetricsBreakdownDto.
object
Group label (product/customer/plan name, or “Unattributed”).
Aggregated value for the group (sum for counters, average for rates).
How many tracker rows folded into this group.
Group value as a fraction (0..1) of decimal UsageMetricsBreakdownDto.GrandTotal.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
Server-computed breakdown of a single metric grouped by a dimension (product / customer / plan), already sorted and limited to the top N rows. The grouping, sort and top-N happen server-side so the client never over-fetches the full snapshot just to render a small table.
object
The metric this breakdown is for, e.g. “api.requests.count”.
Dimension the rows are grouped by: “product”, “customer” or “plan”.
True when the metric carries per-entitlement/product attribution (i.e. a breakdown is meaningful).
Total number of distinct groups before the top-N limit (for the “showing top N of M” note).
Sum across all groups, used to compute each row’s share.
The top-N groups by value, highest first.
A single group within a UsageMetricsBreakdownDto.
object
Group label (product/customer/plan name, or “Unattributed”).
Aggregated value for the group (sum for counters, average for rates).
How many tracker rows folded into this group.
Group value as a fraction (0..1) of decimal UsageMetricsBreakdownDto.GrandTotal.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
Example generated
{ "metricName": "example", "groupBy": "example", "isAttributed": true, "totalGroups": 1, "grandTotal": 1, "rows": [ { "label": "example", "value": 1, "items": 1, "share": 1, "numberFormat": "example" } ]}Server-computed breakdown of a single metric grouped by a dimension (product / customer / plan), already sorted and limited to the top N rows. The grouping, sort and top-N happen server-side so the client never over-fetches the full snapshot just to render a small table.
object
The metric this breakdown is for, e.g. “api.requests.count”.
Dimension the rows are grouped by: “product”, “customer” or “plan”.
True when the metric carries per-entitlement/product attribution (i.e. a breakdown is meaningful).
Total number of distinct groups before the top-N limit (for the “showing top N of M” note).
Sum across all groups, used to compute each row’s share.
The top-N groups by value, highest first.
A single group within a UsageMetricsBreakdownDto.
object
Group label (product/customer/plan name, or “Unattributed”).
Aggregated value for the group (sum for counters, average for rates).
How many tracker rows folded into this group.
Group value as a fraction (0..1) of decimal UsageMetricsBreakdownDto.GrandTotal.
Display format hint, e.g. “0”, “0.0”, “0.0%”.
Example generated
{ "metricName": "example", "groupBy": "example", "isAttributed": true, "totalGroups": 1, "grandTotal": 1, "rows": [ { "label": "example", "value": 1, "items": 1, "share": 1, "numberFormat": "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"}