RevKeenDocs
StatusSupport
API Reference

List Abandonment Alerts

Get paginated list of abandonment alerts 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/abandonment

Get paginated list of abandonment alerts 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

status?string

Filter by alert status

Value in

  • "open"
  • "recovered"
  • "expired"
  • "dismissed"
severity?string

Filter by severity level

Value in

  • "low"
  • "medium"
  • "high"
  • "critical"
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/abandonment" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "alerts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "checkout_session_id": "119f7182-f55f-49cd-a2a6-13462e02671c",      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",      "customer_email": "string",      "severity": "string",      "status": "string",      "cart_value_cents": 0,      "currency": "string",      "last_step_reached": "string",      "entered_email": true,      "entered_payment_info": true,      "payment_attempted": true,      "time_spent_seconds": 0,      "abandoned_at": "2019-08-24T14:15:22Z",      "detected_at": "2019-08-24T14:15:22Z",      "recovery_email_sent": true,      "webhook_notified": true    }  ],  "total": 0,  "page": 0,  "page_size": 0}

Get an accounting-led invoice payment request GET

--- **Related endpoints** - `POST /integrations/accounting/invoice-payment-requests` — Create an accounting-led invoice payment request **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

Abandonment Alert Summary GET

Get aggregated abandonment alert metrics by status and severity --- **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