GET /smtp/statistics/events

Servers

Query parameters

Name Type Required Description
endDate String No

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

days Integer No

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

limit Integer No

Number limitation for the result returned

Default value: 50

email String No

Filter the report for a specific email addresses

templateId Integer No

Filter on a specific template id

tags String No

Filter the report for tags (serialized and urlencoded array)

event String No

Filter the report for a specific event type

Valid values:

  • "requests"
  • "deferred"
  • "blocked"
  • "softBounces"
  • "unsubscribed"
  • "clicks"
  • "bounces"
  • "invalid"
  • "hardBounces"
  • "spam"
  • "opened"
  • "delivered"
startDate String No

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

messageId String No

Filter on a specific message id

offset Integer No

Beginning point in the list to retrieve from.

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.