c5728da3037f

latestOpenAPI 3.0.32026-08-10601779.8 KB
Campaigns

Get campaign performance statistics

Returns sent count and open/click/bounce/unsubscribe/spam counts and rates, all read from stored counters.

Pass include_link_stats=true to also get link_stats — the campaign's links ranked by click count. That part is opt-in because it counts rows in email_link_clicks once per link rather than reading a counter, so leaving it off keeps this endpoint as cheap as it has always been.

get/campaigns/{id}/stats

Query parameters

include_link_statsboolean

When true, include the link_stats breakdown in the response

link_limitinteger

How many links to return in link_stats, most-clicked first. Ignored unless include_link_stats is true.

Response

Successful response

sent_countinteger
unique_open_countinteger
unique_click_countinteger
unsubscribe_countinteger
bounce_countinteger
spam_countinteger
open_ratenumber float
click_ratenumber float
unsubscribe_ratenumber float
bounce_ratenumber float
spam_ratenumber float