Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Events API

Download Logs

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

  1. Processed
  2. Sent
  3. Bounce (Hardbounce and Softbounce)
  4. Dropped
  5. Invalid
  6. Opened
  7. Clicked
  8. Unsubscribe
  9. Abuse
post/logs/download

Headers

api_keystring required

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

Request body

startdatestring date required

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

enddatestring date

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

events'processed' | 'sent' | 'open' | 'click' | 'unsubscribe' | 'bounce' | 'softbounce' | 'invalid' | 'spam' | 'dropped' | 'hardbounce'

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

emailstring

Filter logs based on recipient's email

fromaddressstring

Filter logs based on fromaddress

subjectstring

Filter logs based on subject

xapiheaderstring

Filter logs based on x-apiheader

Response

Success

statusstring