Broadcasts

Site broadcast statistics over time

E-mail numbers of all broadcasts of the site, without filters deleted ones included, split into buckets of interval. 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. Buckets are consecutive days, calendar weeks (Monday to Sunday) or calendar months; the first and the last are cut to the period. Every bucket is present, an empty one with zeros.

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/timeline

Request

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

Path parameters

site_idinteger required

Query parameters

interval'day' | 'week' | 'month'

day, calendar week (Monday to Sunday) or calendar month.

Bucket length

fromstring date required

First day of the period, UTC, included

tostring date

Last day of the period, UTC, included; today when omitted

broadcast_idsinteger[]

Only these broadcast ids from list_broadcasts, up to 100; repeat for several

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

interval'day' | 'week' | 'month' required

day, calendar week (Monday to Sunday) or calendar month.

Changes

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