Email APIEmail statistics

Get your transactional email activity aggregated per day

Authentication

api-keystring

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

Query parameters

limitlongOptionalDefaults to 10
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document on the page
startDatestringOptional

Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)

endDatestringOptional

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)

dayslongOptional

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

tagstringOptional
Tag of the emails
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

Aggregated report informations
reportslist of objects or null

Errors