Docs API Reference Dashboard/bff/dashboard/revenue-retention

/bff/dashboard/revenue-retention

Cohort-based revenue retention: for customers who paid in a previous period, how much do they still pay this period? Returns per-period stats, per-customer retention bands, a stability score and a warning level. The most recent period is "floating" (truncated to today) and compared to the same offset in the prior period for a fair in-progress comparison. Returns insufficient_data if the organisation's first paid order is younger than 2 years.

DashboardgetBffDashboardRevenue-retention

Parameters

1 query

1 total

Query · 1

periodstring | string

Granularity: yearly (3 pairs) or quarterly YoY (12 pairs). Defaults to year.

Default: year

Request

GET /bff/dashboard/revenue-retention

get

curl -X GET "https://api.bizkithub.com/bff/dashboard/revenue-retention?period=year" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Year-over-year revenue retention analysis.

{
  "currency": "example_currency",
  "warning": {
    "note": "marketing_dependency",
    "organisationAgeDays": 0
  },
  "periods": [
    {
      "periodIdx": 0,
      "label": "example_label",
      "baselineStart": "example_baselineStart",
      "baselineEnd": "example_baselineEnd",
      "currentStart": "example_currentStart",
      "currentEnd": "example_currentEnd",
      "isFloating": false,
      "baselineCustomers": 0,
      "retainedCustomers": 0,
      "lostCustomers": 0,
      "customerRetentionRate": 0,
      "baselineRevenue": 0,
      "currentRevenueFromBaselineCustomers": 0,
      "grossRetentionRate": 0,
      "netRetentionRate": 0,
      "avgRevenuePerCustomerBaseline": 0,
      "avgRevenuePerCustomerCurrent": 0,
      "avgRevenuePerCustomerChange": 0,
      "bands": [
        {
          "customerCount": 0,
          "customerPercentage": 0,
          "baselineRevenue": 0,
          "currentRevenue": 0
        }
      ]
    }
  ],
  "currencyMix": {
    "primaryCurrencyId": 0,
    "primaryCurrencyCode": "example_primaryCurrencyCode",
    "otherCurrenciesPresent": false,
    "otherCurrenciesRevenue": 0
  }
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key