Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional emails

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

get/smtp/statistics/events

Query parameters

limitinteger

Number limitation for the result returned

offsetinteger

Beginning point in the list to retrieve from.

startDatestring

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

endDatestring

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

daysinteger

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

emailstring email

Filter the report for a specific email addresses

event'bounces' | 'hardBounces' | 'softBounces' | 'delivered' | 'spam' | 'requests' | 'opened' | 'clicks' | 'invalid' | 'deferred' | 'blocked' | 'unsubscribed' | 'error' | 'loadedByProxy'

Filter the report for a specific event type

tagsstring

Filter the report for tags (serialized and urlencoded array)

messageIdstring

Filter on a specific message id

templateIdinteger

Filter on a specific template id

sort'asc' | 'desc'

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

Response

Email events report informations

Example response

{
  "events": [
    {
      "email": "john.smith@example.com",
      "date": "2017-03-12T12:30:00Z",
      "subject": "Sib client test",
      "messageId": "<201798300811.5787683@relay.domain.com>",
      "event": "delivered",
      "reason": "Error connection timeout",
      "tag": "OrderConfirmation",
      "ip": "165.87.3.15",
      "link": "https://www.someexamplelink.com",
      "from": "john@example.com",
      "templateId": 4
    }
  ]
}