Broadcasts

Broadcast statistics per broadcast

E-mail numbers per broadcast, in one of two ways.

With broadcast_ids (up to 100, from list_broadcasts): every listed live broadcast of the site in the order given, zeros without e-mails; repeated ids count once, unknown, deleted and foreign ids are left out. The period is optional here: without from and to the numbers cover the whole life, and period is null. This is how to get the numbers of a page of the list in one call.

Without broadcast_ids the period is required: up to 100 live broadcasts by send, most first, including those with activity but no sending in the period. For the rest pass broadcast_ids. Deleted broadcasts and e-mails without a broadcast are left out, so the sum may be below get_broadcasts_stats.

status, search, created_since, started_since, started_before and folder_id narrow either way to the broadcasts that match every one given, and then every matched broadcast is listed, zero ones too: one call gives the numbers of a folder, of the running broadcasts or of the broadcasts sent in a month. total is the sum of the listed broadcasts; use it rather than adding the items up.

Each number counts the events dated in the period on its own, so the numbers are independent: a bounce or an open of an e-mail sent before the period counts here too.

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/stats/by-broadcast

Request

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

Path parameters

site_idinteger required

Query parameters

broadcast_idsinteger[]

Broadcast ids from list_broadcasts, up to 100; repeat for several. With them the period is optional

fromstring date

UTC day, included; omit for the whole life

tostring date

UTC day, included; with from, today when omitted

statusBroadcastStatus[]

Only broadcasts in any of these statuses; repeat for several

searchstring

Words of the name in order; case, spacing and punctuation are ignored. Or the exact id

created_sincestring date-time

Created at or after; without an offset, taken as UTC; a plain date means its start

started_sincestring date-time

Sending first started at or after this moment (started_at); without an offset, taken as UTC; a plain date means its start

started_beforestring date-time

Sending first started before this moment, excluded; without an offset, taken as UTC; a plain date means its start

folder_idinteger

Only the items of this folder, an id from list_folders; 0 is General

Response

Successful Response

matchedinteger nullable

How many live broadcasts the filters or ids matched; null without them. 0 means nothing matched, not that nothing happened: check the filters or ids

Changes

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