Fetch Email Broadcast Stats

Delivery progress, engagement and revenue for one email broadcast, the same numbers as
the broadcast's page in the ClickFunnels dashboard.

The numbers cover the broadcast's send window, returned as timerange: from when
sending began until two weeks after it completed, or until now while it has not
completed, capped at 90 days after sending began. A broadcast that has not started
sending reports the last 90 days, with every number zero. There are no timerange parameters;
the timerange_start and timerange_end parameters of the funnel and page stats
endpoints are refused with a 422 rather than silently ignored.

Counts are unique contacts, except opened and clicked, which count every event.
Rates are whole percentages (0-100) of the audience (progress.total), rounded to the
nearest integer, so a share under 0.5% reads 0 next to a non-zero count; the counts are
authoritative. click_to_open_rate is unique clicks over unique opens. Revenue is
attributed to the broadcast when the buyer reached the order through one of its links,
summed across every send of the broadcast. Only live-mode transactions in the workspace
currency are counted (a workspace with no currency set has nothing to filter on, so
currency is null and every currency is summed); test-mode orders are excluded.

progress.total is the audience size recorded when the broadcast sent, summed over every
send of the broadcast, and is null before the first send has run. Stats are cached for a
few minutes while a broadcast is sending and longer once it has completed.

The split-test variants and the winner are on the broadcast record itself
(GET /api/v2/emails/broadcasts/{id}). Add expand[]=variants for each variant's numbers:
recipients, bounces, unique clicks, unsubscribes and spam complaints, reported separately for
the split test and for the winner's send to the rest of the audience, so variants are
compared on the test alone. Only the open pixel identifies a variant, so these are derived
from the record of which contacts were sent which variant. That record is removed 30 days
after the broadcast completes, and from then on test and winner_send are null; read
them once the two-week stats window has closed and within 30 days of completion. Expanding variants can take a
few seconds on a large broadcast the first time; the result is cached like the other numbers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
expand[]
array of strings

Expand additional data in the response. Use expand[]=variants to include a variants array with each split-test variant's numbers, split into the test and the winner's send.

expand[]
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json