Site broadcast statistics
E-mail numbers of all broadcasts of the site over the period, summed; without filters deleted broadcasts count too. broadcast_ids, status, search, created_since, started_since, started_before and folder_id narrow the count to the live broadcasts that match every one given; matched says how many, and matched: 0 means no broadcast matched. Per broadcast: get_broadcasts_stats_by_broadcast; over time: get_broadcasts_stats_timeline.
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.
Request
- Base URLhttps://api.getsitecontrol.com
- AuthHTTP bearer
Path parameters
Query parameters
First day of the period, UTC, included
Last day of the period, UTC, included; today when omitted
Only these broadcast ids from list_broadcasts, up to 100; repeat for several
Only broadcasts in any of these statuses; repeat for several
Words of the name in order; case, spacing and punctuation are ignored. Or the exact id
Created at or after; without an offset, taken as UTC; a plain date means its start
Sending first started at or after this moment (started_at); without an offset, taken as UTC; a plain date means its start
Sending first started before this moment, excluded; without an offset, taken as UTC; a plain date means its start
Only the items of this folder, an id from list_folders; 0 is General
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.