Email APIEmail statistics

Get your transactional email activity aggregated over a period of time

This endpoint will show the aggregated stats for past 90 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

startDatestringOptional

Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

endDatestringOptional

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

dayslongOptional

Number of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’

tagstringOptional
Tag of the emails

Response

Aggregated report informations
blockedlong or null
Number of blocked contact emails for the timeframe
clickslong or null
Number of clicks for the timeframe
deliveredlong or null
Number of delivered emails for the timeframe
hardBounceslong or null
Number of hardbounces for the timeframe
invalidlong or null
Number of invalid emails for the timeframe
openslong or null
Number of openings for the timeframe
rangestring or null
Time frame of the report
requestslong or null
Number of requests for the timeframe
softBounceslong or null
Number of softbounces for the timeframe
spamReportslong or null

Number of complaint (spam report) for the timeframe

uniqueClickslong or null
Number of unique clicks for the timeframe
uniqueOpenslong or null
Number of unique openings for the timeframe
unsubscribedlong or null
Number of unsubscribed emails for the timeframe

Errors