RevKeenDocs
StatusSupport
API Reference

List Winback Opportunities

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.

GET
/analytics/checkout/winback

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 for SDK auto-paging helpers.

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

Query Parameters

type?string

Filter by opportunity type

Value in

  • "cancelled_subscription"
  • "repeat_abandoner"
  • "lapsed_customer"
status?string

Filter by status

Value in

  • "identified"
  • "contacted"
  • "converted"
  • "declined"
  • "expired"
minValueCents?|

Minimum potential value in cents

Range0 <= value
page?integer

Page number

Range1 <= value
Default1
pageSize?integer

Results per page (1-100)

Range1 <= value <= 100
Default20

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" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "opportunities": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",      "customer_email": "string",      "opportunity_type": "cancelled_subscription",      "status": "identified",      "potential_value_cents": 0,      "currency": "string",      "previous_purchases_cents": 0,      "cancel_reason": "string",      "last_activity_at": "2019-08-24T14:15:22Z",      "winback_emails_sent": 0,      "special_offer_code": "string",      "special_offer_discount": 0,      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "page_size": 0}

Checkout Funnel Analytics GET

Get stage-by-stage checkout conversion funnel metrics. Shows sessions, drop-offs, and conversion rates at each step. --- **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/abandonment/summary` — Abandonment Alert Summary

Winback Opportunities Summary GET

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