Hero KPIs

The dashboard hero strip payload: beneficiary retention %, Money-Out payout count, and average payout size per currency across the requested window, each with the % change vs the equal-length prior window. A pure read-model over Payout — nothing is stored. Results are scoped to the caller’s Business and environment.

GET /v1/reporting/hero-kpis

Hero KPI strip (retention %, payout count, avg payout size) for the current Business and environment

cURL

curl --request GET \
  --url https://api.example.com/v1/reporting/hero-kpis \
  --header 'Authorization: Bearer <token>'

200

{
  "retention_pct": 123,
  "retention_trend_pct": 123,
  "payout_count": 123,
  "payout_count_trend_pct": 123,
  "avg_payout_size": [
    {
      "currency": "<string>",
      "avg_minor": 123,
      "trend_pct": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Query Parameters

from · string · required

Inclusive lower bound of the window (ISO-8601 date or timestamp).

to · string · required

Inclusive upper bound of the window (ISO-8601 date or timestamp). A date-only value covers the whole day.

Response

200

application/json

retention_pct · number | null · required

Repeat-payee rate: share of window beneficiaries also paid in the prior window. Null when the window paid no beneficiary.

retention_trend_pct · number | null · required

% change in retention vs the prior window's retention; null with no baseline.

payout_count · number · required

Count of Money-Out payouts in the window.

payout_count_trend_pct · number | null · required

% change in payout count vs the prior window; null with no baseline.

avg_payout_size · object[] · required

Average payout size per currency present in the window, sorted by currency.

Show child attributes