v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Events API

Fetch Summary Stats

Email API captures different events like Open, Click, Unsubscribe etc and generates statistics. This data is available in your Email API account as well as you can fetch the same via this API.

The statistics are calculated every hour in your set timezone.

Note: To check and update timezone, please log in to your Email API account and navigate through My Profile.

The following retention policy is applied to the statistics:

Monthly stats are stored throughout the lifespan of the domain. Events data are available for last 90 days only.

get/stats

Query parameters

limitinteger
offsetinteger
aggregated_by'day' | 'week' | 'month'
enddatestring date

The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

startdatestring date required

The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.

Headers

api_keystring required

Response

Success

messagestring