Sign in

v1

latestOpenAPI 3.0.02026-07-2612645160.3 KB
email-channel

Get email campaign metrics

Aggregated delivery + engagement counters and rates, computed from recipient statuses and SendGrid webhook events.

get/api/public/email-campaign/metrics/{id}

Path parameters

idstring uuid required

Headers

x-api-keystring required

API key needed to authorize the request

Response

total_recipientsnumber required
sentnumber required
failednumber required
pendingnumber required
deliverednumber required
openednumber required
clickednumber required
bouncednumber required
droppednumber required
open_ratenumber required

opened / delivered (0..1)

click_ratenumber required

clicked / delivered (0..1)

bounce_ratenumber required

bounced / (delivered + bounced) (0..1)