Fetch Event Logs

Lets you to retrieve the email transaction logs.

Following events can be passed in query parameter events:

  • Processed
  • Sent
  • Bounce (Hard bounce and Soft bounce)
  • Dropped
  • Invalid
  • Opened
  • Clicked
  • Unsubscribe
  • Abuse

you can also pass Aggregate events :

  • total_requested (Includes all entries)
  • total_delivered (Includes 'Sent', 'Open', 'Click', 'Unsubscribe' and 'Spam')
  • total_opened (Includes 'Open', 'Click', 'Unsubscribe' and 'Spam')
  • total_clicked (Includes 'Click' and 'Unsubscribe')

Make sure to pass the above events individually as any combination including the above 4 event types will return an error. Data fetching is based on a combination of 'limit' & 'scrollid'. 'limit' indicates the number of rows that will be passed in the response. The maximum number of rows allowed for a single request is 5000. If the 'limit' is not set, 50 rows are retrieved. In the response message, the 'scrollid' is shared for that request. To fetch the next batch of rows, The 'scrollid' needs to be passed.

Query Params
string

Use the scrollid provided in your first query to fetch the next batch of data

integer
0 to 1000
Defaults to 0

The point in the list to begin retrieving results.

string
length ≤ 255

Filter logs based on fromaddress

string
length ≤ 255

Filter logs based on recipient's email

string
length ≤ 255

Filter logs based on x-apiheader

string
length ≤ 255

Filter logs based on subject

integer
1 to 1000
Defaults to 10

The number of results to return.

date

The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

date

The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.

string
enum

Sort based on email sent time

Allowed:
string
enum

Filter based on different email events. If not passed, all events will be fetched. Multiple comma separated events are allowed.

Headers
string
required

Your Email API Key. This you can get by login into your account.

Responses

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json