GEgetsitecontrol
Broadcasts

Get a broadcast

One broadcast with the fields of list_broadcasts, nothing shortened, plus its whole audience: the condition tree and the recipient settings (limit, sort, quality gate), the A/B test split and duration, and whether links get UTM parameters. How many contacts it reaches is get_broadcast_recipients, its numbers are in get_broadcast_stats, its clicks by link in get_broadcast_clicks, the body of its e-mail in get_email.

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

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

idinteger required
namestring nullable

Name in the admin

status'draft' | 'scheduled' | 'testing' | 'running' | 'paused' | 'stopped' | 'completed'

draft: not scheduled or started yet. scheduled: waits for schedule.scheduled_at. testing: an A/B broadcast sending its variants to a test group or choosing the winner. running: being prepared or sending. paused: sending paused; it can be resumed. stopped: stopped before the end; it will not resume; to send it to those who did not get it, the user picks Resend > Resend to non-recipients on it in the admin. completed: sending finished.

status_reason'ab_test' | 'completed' | 'scheduled' | 'no_recipients' | 'balance' | 'blocked_suspicious_activity' | 'blocked_poor_delivery' | 'sandbox' | 'not_on_plan' | 'failed' | 'paused_too_long' | 'stop_all' | 'deleted' | 'other'

Why a status changed; null when a person simply made the change. While the site's sending is held, diagnose_email_sending names what holds it.

ab_test: the A/B test finished or its winner was chosen. completed: every e-mail was sent. scheduled: started at the scheduled time. no_recipients: stopped because no contact matched the audience. balance: paused because the e-mail balance ran out. blocked_suspicious_activity: stopped because our automatic check for suspicious activity blocked the site's sending. blocked_poor_delivery: stopped because the site's sending was blocked: too many recipients bounced or complained. It stays blocked until the contact list is cleaned and support lifts the block. sandbox: stopped because sending is not enabled for the site yet or is paused pending a review. not_on_plan: paused because the site's plan no longer included broadcasts (a plan change, an ended trial or a suspended subscription). failed: stopped because it could not be prepared for sending. paused_too_long: stopped after being paused for over 30 days. stop_all: every broadcast of the site was paused or stopped at once. deleted: the broadcast was deleted, one entry per deletion: a preparing, running or paused broadcast is stopped by it (status stopped), any other keeps its status in the entry. other: another automatic change.

email_idinteger nullable

The broadcast's e-mail; null when it has none

subjectstring nullable

Subject of the e-mail

preview_textstring nullable

Preview text of the e-mail, shown after the subject in inboxes

created_atstring date-time required
updated_atstring date-time required

Last change of the broadcast, its status or its e-mail; see the list description; a move to another folder does not change it

started_atstring date-time nullable

When sending first started; null until then

ended_atstring date-time nullable

When the broadcast was stopped or completed; null until then

launched_atstring date-time nullable

Latest start or scheduling by a person; null when there was none

edited_atstring date-time nullable

Last change made in the editor, to the broadcast or to one of its e-mails, A/B variants included

warningsstring[] required

Empty unless the broadcast could not be read in full; wording is not stable, do not parse

truncatedstring[]

Parts shortened in the list, as paths; the card has them whole. Empty when nothing was cut

Changes

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