Code preference:
Curl
Ruby
Php
Python
Node.js
C#
Java

Email event reports

Developers can access information about email event reports using this API. Following is the operation supported by this API.

Types of events

  • Bounces: bounces ( hard + soft bounces )
  • Hard bounces: hard_bounce
  • Soft bounces: soft_bounce
  • Blocks: blocks
  • Spam reports: spam
  • Delivered: delivery
  • Requests: requests
  • Opened: views
  • Clicks: clicks
  • Invalid emails: invalid
  • Deferred: deferred
  • Unsubscribed: unsubscribed

 

Input Parameter Description
limit To limit the number of results returned. It should be an integer [Optional].
start_date The start date to get report from. Date must be in YYYY-MM-DD format and should be before the end_date [Optional].
end_date The end date to get report till date. Date must be in YYYY-MM-DD format and should be after the start_date [Optional].
offset Beginning point in the list to retrieve from. It should be an integer [Optional].
date Specific date to get its report. Date must be in YYYY-MM-DD format and should be earlier than todays date [Optional].
days Number of days in the past (includes today). If specified, must be an integer greater than 0 [Optional].
email Email address to search report for [Optional].
event Type of event to search report for [Optional].
tags The existing tags you will specify to search report for [Optional].
message_id The existing message-id you will specify to search report for [Optional].
template_id The existing template id you will specify to search report for template already sent [Optional].

Example :

Sample Output :