Metrics

Base URL: $BUSINESS_API

Endpoints

List utility governed metrics catalog

Logs

GET /metrics

Returns, under data, the tenant's month-to-date operational figures, each with a key, name, unit, value and computation timestamp: billed and collected amounts, collection efficiency, billed volume, open receivables, active connections and active meters. Values are computed on each call. Requires the reports:read permission.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Metrics catalog

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/metrics" \
  -H "Authorization: Bearer sk_test_..."
Response 200

Metrics catalog