Skip to main content
GET
Analytics for a date range

Authorizations

X-API-Key
string
header
required

Query Parameters

range
string

Preset: today, yesterday, 7d, 14d (default), 30d, 90d.

from
string

Start date YYYY-MM-DD (needs 'to').

to
string

End date YYYY-MM-DD (needs 'from').

campaign
integer

Limit to one campaign id.

Response

200

JSON {range:{preset, from, to, days}, campaign, totals:{sent, reached, failed, replies, positive, sent_per_day, reply_per_1k, emails_per_positive}, lifetime:{reached, bounced, pending, bounce_rate}, series, hours:[{hour,sent,replies}], stages, by_campaign, by_mailbox (top 200), by_domain, campaigns}.