Get email campaign statistics

Deprecated

GET
/stats

Returns aggregated statistics for one email campaign. By default (detailed omitted or not 'true') a flat summary is returned; with detailed=true a { global, steps } breakdown is returned. Statistics are computed on demand and cached. PITFALLS: when the campaign is not found the route answers 401 (not 404) with { error: 'Campaign not found' }; ANY internal error also answers 401 { error: 'You must be logged in' }. detailed is read as the string 'true'; any other value (including the boolean true serialised elsewhere) is treated as the summary. New integrations should use the multichannel /advanced campaign endpoints instead.

Authorization

apiKey
Authorization<token>

Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.

In: header

Query Parameters

campaignId*string
detailed?boolean

Pass true for the per-step breakdown.

start?string

ISO start date filter.

end?string
providerId?string

Restrict stats to one provider.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/stats?campaignId=65f1a2b3c4d5e6f73478765e" \  -H "Authorization: YOUR_API_KEY"
{  "mailsSent": 1200,  "uniqueOpensPercent": 48.5,  "opens": 1700,  "linkClickedPercent": 12.3,  "repliedPercent": 6.1,  "bouncedPercent": 1.2,  "unsubscribePercent": 0.4,  "progressPercent": 73}