GEgetsitecontrol
Broadcasts

Broadcast recipients

Target audience and sending progress. Before sending, including preparation, total is an estimate (total_is_estimate=true); sent and queued are null. After start, total = sent + queued. An unknown queue leaves both queued and total null. Sent is not delivered; delivery counts are in get_broadcast_stats.

Example while sending: {"sent":800,"queued":200,"total":1000,"total_is_estimate":false}.

get/v1/sites/{site_id}/broadcasts/{broadcast_id}/recipients

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
broadcast_idinteger required

Broadcast id from list_broadcasts

Response

Successful Response

sentinteger nullable required

E-mails sent so far, not delivered. Null before sending starts; zero if started but none sent.

queuedinteger nullable required

E-mails waiting to be sent. Null before sending starts or when unknown; zero when none remain.

totalinteger nullable required

Audience estimate before sending; sent plus queued after start. Null if the estimate or queue is unknown.

total_is_estimateboolean required

True for drafts, scheduled broadcasts and audience preparation; false after sending starts.

qualityobject nullable

Estimated total by e-mail quality for drafts and scheduled broadcasts; null otherwise. Ungraded contacts are unknown.

Changes

No recorded changes to this operation across all 1 revision of this API.