CDP REST APIAPI Reference
At-Risk Customers
Customers whose completed-order cadence indicates churn risk.
GET /cdp/insights/at-risk returns customers whose last completed order is more
than twice their normal purchase cadence. Single-order customers use the brand's
median repeat cadence when available.
Requires the beta:cdp-commerce permission on your brand.
Request
GET /cdp/insights/at-risk
Authorization: Bearer vyg_…| Param | Type | Default | Description |
|---|---|---|---|
limit | integer | 25 | Page size, clamped to a maximum of 100. |
offset | integer | 0 | Offset; offset + limit must stay within the 10,000-row window or the request is rejected 400. |
as_of | string | now | Optional ISO 8601 timestamp used for days-since-last-order. |
Response 200
{
"list": [
{
"contact_id": "c9f0…",
"last_order_at": "2026-03-02T00:00:00.000Z",
"days_since_last_order": 121,
"median_inter_order_days": 30,
"brand_median_inter_order_days": 30,
"at_risk": true,
"at_risk_score": 4.03
}
],
"totalSize": 1,
"offset": 0,
"pageSize": 25,
"scope": "your-shop.myshopify.com",
"nextCursor": null
}Rows are ordered by highest at_risk_score first.
Errors
| Status | When |
|---|---|
400 | Deep offset, or invalid as_of. |
401 | Missing or invalid credential. |
403 | Brand not enrolled in the commerce beta (beta_not_enabled), or no connected Shopify integration (integration_not_connected). |
405 | Non-GET method. |