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

GET
/analytics/checkout/winback

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

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

Default1
Range1 <= value
pageSize?integer

Results per page (1-100)

Default20
Range1 <= value <= 100

Response Body

application/json

curl "https://api.revkeen.com/v2/analytics/checkout/winback" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "opportunities": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
      "customerEmail": "string",
      "opportunityType": "cancelled_subscription",
      "status": "identified",
      "potentialValueCents": 0,
      "currency": "string",
      "previousPurchasesCents": 0,
      "cancelReason": "string",
      "lastActivityAt": "string",
      "winbackEmailsSent": 0,
      "specialOfferCode": "string",
      "specialOfferDiscount": 0,
      "createdAt": "string",
      "expiresAt": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0
}
Edit on GitHub