Get Recipient Stats
Returns recipient counts for a campaign, filtered by included and excluded segments. Useful for previewing deliverable audience size (email-eligible, SMS-eligible, etc.) before a send.
Path Parameters
idnumberrequired
Campaign id to return recipient stats for.
Query Parameters
includearray
Optional array of segment ids to include in the recipient count. Repeat the parameter for multiple ids (e.g.
?include=1&include=7). When omitted, all of the campaign's assigned segments are included.excludearray
Optional array of segment ids to exclude from the recipient count. Repeat the parameter for multiple ids. Exclusion is applied after inclusion.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"stats": {
"total_count": 6067,
"total_email_optout": 890,
"total_email_enabled": 5143,
"total_push_enabled": 1464,
"total_sms_optout": 1231,
"total_sms_enabled": 2493,
"total_donotcontact": 1,
"total_webpush_enabled": 0
}
}
}
HTTP Response Parameters
statsobject
Recipient counts keyed by reachability: total_count, total_email_enabled / total_email_optout, total_sms_enabled / total_sms_optout, total_push_enabled, total_webpush_enabled, total_donotcontact.