RevKeenDocs
StatusSupport
API Reference

Winback Opportunities Summary

Get aggregated winback opportunity metrics by type and status --- **Related endpoints** - `GET /analytics/revenue/mrr-summary` — MRR Summary - `GET /analytics/revenue/time-series` — Revenue Time Series - `GET /analytics/invoices/ar-aging` — A/R Aging Report - `GET /analytics/collections/dso` — Days Sales Outstanding - `GET /analytics/customers/ltv` — Customer LTV - `GET /analytics/customers/{customerId}` — Customer Analytics - `GET /analytics/payment-links/conversion` — Payment Link Conversion - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics

GET
/analytics/checkout/winback/summary

Get aggregated winback opportunity metrics by type and status

Related endpoints

  • GET /analytics/revenue/mrr-summary — MRR Summary
  • GET /analytics/revenue/time-series — Revenue Time Series
  • GET /analytics/invoices/ar-aging — A/R Aging Report
  • GET /analytics/collections/dso — Days Sales Outstanding
  • GET /analytics/customers/ltv — Customer LTV
  • GET /analytics/customers/{customerId} — Customer Analytics
  • GET /analytics/payment-links/conversion — Payment Link Conversion
  • GET /analytics/checkout/funnel — Checkout Funnel Analytics

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/analytics/checkout/winback/summary" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "total_opportunities": 0,  "by_type": {    "cancelled_subscription": 0,    "repeat_abandoner": 0,    "lapsed_customer": 0  },  "by_status": {    "identified": 0,    "contacted": 0,    "converted": 0,    "declined": 0,    "expired": 0  },  "total_potential_value_cents": 0,  "recovered_value_cents": 0,  "conversion_rate": 0}

List Winback Opportunities GET

Get paginated list of winback opportunities with filtering --- **Related endpoints** - `GET /analytics/revenue/mrr-summary` — MRR Summary - `GET /analytics/revenue/time-series` — Revenue Time Series - `GET /analytics/invoices/ar-aging` — A/R Aging Report - `GET /analytics/collections/dso` — Days Sales Outstanding - `GET /analytics/customers/ltv` — Customer LTV - `GET /analytics/customers/{customerId}` — Customer Analytics - `GET /analytics/payment-links/conversion` — Payment Link Conversion - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Days Sales Outstanding GET

Calculate DSO and collection health metrics --- **Related endpoints** - `GET /analytics/revenue/mrr-summary` — MRR Summary - `GET /analytics/revenue/time-series` — Revenue Time Series - `GET /analytics/invoices/ar-aging` — A/R Aging Report - `GET /analytics/customers/ltv` — Customer LTV - `GET /analytics/customers/{customerId}` — Customer Analytics - `GET /analytics/payment-links/conversion` — Payment Link Conversion - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics - `GET /analytics/checkout/abandonment/summary` — Abandonment Alert Summary