Get Report.

The report API call returns a text/csv file with the event details.

Function

  • report()

Url

  • POST: /PuresendService/automation/v1/report

Parameters

  • automation_id: Integer Required
    • The automation_id is the automation id which created in the https://<Instance>/automation/index.jsp.
  • types: Array Optional
    • Event Type
      • Request
      • Failed
      • Bounce
      • Delivered
      • Clickthru
      • Open
      • Opt-out
      • Browser Type
  • sub_types: Array Optional
    • Bounced Sub Event Types
      • Permanent
      • Temporary
      • Transient
      • Unknown
      • Blocked
      • Retry
  • start_date: YYYY-MM-DD Optional
    • Date range (start)
  • end_date: YYYY-MM-DD Optional
    • Date range (end)
  • limit: Integer Optional
    • The maximum number of items to retrieve
    • The Maximum is 100
  • offset: Integer Optional
    • The starting point or index of items to retrieve

Return

  • A text/csv file with the event details

Examples

{
    "automation_id": 1,
    "types": ["Clickthru", "Open"],
    "start_date": "2023-11-09",
    "end_date": "2024-02-29",
    "limit": 20,
    "offset": 0
}

ListEntryId,Email,Type,SubType,Ip,Message,At
123456789093069,example@exmaple.com,Clickthru,,127.0.0.1,https://example.com,2024-01-16 20:04:08