Events API

Download Logs

This endpoint allows you to download the email transaction logs which includes following events:

The link to the final file with all the logs will be sent to the registered email id or the selected SFTP server.

post/messages/download

Request

start_datestring date

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

end_datestring date

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

event_start_datestring date-time

Use this parameter to download events data happening on a particular day. Must follow format (yyyy-mm-dd HH:mm:ss)

event_end_datestring date-time

Use this parameter to download events data happening on a particular day. Must follow format (yyyy-mm-dd HH:mm:ss)

emailstring

Filter logs based on recipient's email

fromaddressstring

Filter logs based on fromaddress

subjectstring

Filter logs based on subject

custom_argsstring

Additional custom arguments or headers.

tagsstring

Filter logs based on tags

delivery_type'sftp' | 'email'

Report delivery method for logs. Defaults to registered email.

sftp_connection_namestring

Name of the SFTP connection for file upload. Obtained from CPaaS panel.

eventsstring[]

Provide event types to filter logs.

latestboolean

If true, you will receive details of all the statuses in the report. If false, only the current status of the email request is included.

{
  "start_date": "2023-10-01",
  "end_date": "2023-10-31",
  "event_start_date": "2025-02-03 23:00:00",
  "event_end_date": "2025-02-25 09:00:00"
}

Accepted

No recorded changes to this operation across all 2 revisions of this API.