Skip to main content

Overview

atRisk() returns a paginated list of users whose churn risk score exceeds a given threshold. Use it for bulk outreach campaigns, CS dashboards, or nightly reports. For streaming all at-risk users without pagination management, see atRiskAll().

Signature

AtRiskOptions

number
Minimum score to include (0–1). Default: 0.5. Must be a finite number between 0 and 1.
string
Filter to users on a specific plan (e.g. 'pro', 'enterprise'). Requires plan to have been set via identify().
number
Page size. Default: 50. Maximum: 200.
number
Pagination offset. Default: 0.
AbortSignal
Cancel the request.

AtRiskResult

Examples

Get high-risk users

Filter by plan

Paginate all high-risk users

Nightly CS report

Errors