PT EN

Métricas

URL base: $BUSINESS_API

Operações

Listar métricas

Registos

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.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Metrics catalog

Permissões reports:read · Funções: admin, analyst, finance, owner

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

Metrics catalog