Retrieve marketing campaign stats
What a send actually did, per A/B arm plus the campaign’s totals. A campaign with no arms reports one row with an empty variant_key. EVERY NUMBER IS DERIVED LIVE from the messages the campaign created rather than from a stored counter, so it cannot drift when a send is retried, a provider reports late, or a webhook is replayed. skipped AND blocked MEAN DIFFERENT THINGS AND ONLY ONE IS ACTIONABLE. skipped is the platform correctly declining on the CONTACT’s behalf: no consent, a frequency cap, a suppression, or a channel with no transport, none of which the merchant can change for that person. blocked is the store’s own delivery switch being off, which the merchant can go and turn back on. Surface them separately or the one fixable misconfiguration disappears into a bucket nobody reads. REVENUE IS A LIST KEYED BY CURRENCY, never a single number. A store selling into several regions can have orders in different currencies attributed to one campaign, and adding those together produces a figure that is not money in any of them. An empty list means nothing has been attributed yet, which is not the same as zero. IT NAMES NOBODY. These are counts over an audience, not the people in it; resolving who was mailed costs read_marketing_contacts and a different family.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Path Parameters
Response
Success
