Skip to main content

Metrics

The dashboard's recovery indicators — totals, month by month, by payment method and by channel. Read-only; months sets the window (default: 6 months).

CommandHTTPDescription
metrics recovery listGET /v1/metrics/recoveryRecovery metrics

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# Recovery over the last 12 months
kobana dunning metrics recovery list --params '{"months": 12}' --fields "period,totals,by_month"

Next steps​