Broadcasts

Broadcast statistics

E-mail numbers of one broadcast over its whole life, its A/B variants included, plus how many e-mails are still queued and the numbers of each A/B variant. For a period use get_broadcasts_stats_by_broadcast with this id. While the broadcast is being prepared, sent or paused, progress gives the e-mails sent and left, the current step and the estimated finish time.

Every number counts e-mails, one e-mail being one message to one recipient, and each e-mail at most once per metric: send e-mails sent, including those rejected on sending; bounce e-mails that bounced or were rejected on sending; deliver is send minus bounce, never below zero; open e-mails opened; click e-mails with at least one link clicked; unsubscribe e-mails whose recipient unsubscribed through them; complaint e-mails reported as spam through the recipient's mail provider. rates next to each total gives the delivery, open, click, click-to-open, unsubscribe, complaint and bounce rates, rounded to 4 places; a rate is null when its denominator is 0, as it is undefined, not zero.

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

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

queuedinteger nullable

E-mails waiting to be sent, as progress.queued. null for a draft or a scheduled broadcast and when the count is not available; 0 once stopped or completed

Changes

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