Sequences
Get recipient insights
Aggregate counts for recipients tab footer. Requires a USER API key. active excludes paused instances (see paused). completed covers every successful closure — natural completion plus early exits with reason REPLIED, MEETING_BOOKED, or MANUAL — broken down by reason in completedByReason. exited is reserved for unsuccessful early exits (UNSUBSCRIBED, DO_NOT_CONTACT).
get/public/v1/sequences/{sequenceId}/recipients/insights
Path parameters
sequenceIdnumber nullable
Example:101
Response
Recipient insights
Example response
{
"active": 1,
"paused": 1,
"enrolled": 1,
"exited": 1,
"completed": 1,
"removed": 1,
"failed": 1,
"failedToEnroll": 1
}Changes
Changed in 1 of the 2 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○