Get all your transactional email activity (unaggregated events)
This endpoint will show the aggregated stats for past 30 days by default if startDate
and endDate
OR days
is not passed. The date range can not exceed 90 days
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | Number limitation for the result returned | |
offset | number | Beginning point in the list to retrieve from. | |
startDate | string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | |
endDate | string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | |
days | number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | |
email | string | Filter the report for a specific email addresses | |
event | string | Filter the report for a specific event type | |
tags | string | Filter the report for tags (serialized and urlencoded array) | |
messageId | string | Filter on a specific message id | |
templateId | number | Filter on a specific template id | |
sort | string | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"events":[{"email":"john.smith@example.com","date":"2017-03-12T12:30:00.000Z","messageId":"\u003c201798300811.5787683@example.domain.com\u003e","event":"deferred","reason":"Error connection timeout","tag":"OrderConfirmation","from":"john@example.com","templateId":4},{"email":"john.smith@example.com","date":"2017-03-13T16:30:00.000Z","messageId":"\u003c201798300811.5787683@example.domain.com\u003e","event":"delivered","tag":"OrderConfirmation","from":"john@example.com","templateId":5}]}