Skip to main content

kobana dunning metrics

Commands of kobana dunning metrics. Every global option (Global options) applies here.

CommandHTTPDescription
metrics recoveryGET /v1/metrics/recoveryRecovery metrics

metrics recovery​

Recovery metrics

kobana dunning metrics recovery [OPTIONS]

GET /v1/metrics/recovery

Returns the period’s recovery metrics (default: last 6 months, counted from the first day of the starting month).

Query parameters

NameTypeRequiredDescription
monthsintegernoWindow in months (1–24; default 6).

Headers

NameTypeRequiredDescription
X-Workspace-IdstringnoWorkspace the call acts on (id or public_id, listed by GET /v1/workspaces). Optional while the organization has a single workspace; with two or more, omitting it is 400 WORKSPACE_REQUIRED. A workspace of another organization is 403 UNKNOWN_WORKSPACE.

Responses

HTTPDescription
200Computed metrics.
400Invalid request (validation error).
404Resource not found or outside your organization.
413Request body larger than 2 MB.