v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Events

Export Events

Export delivery events log information to the specified file format. Required Access Level: Export

post/events/export

Query parameters

eventTypesEventType[]

array

Types of Events to return

fromstring date-time nullable

string

Example:2001-01-01T01:01:01

Starting date for search in YYYY-MM-DDThh:mm:ss format.

tostring date-time nullable

string

Example:2001-01-01T01:01:01

Ending date for search in YYYY-MM-DDThh:mm:ss format.

fileFormat'Csv' | 'Xml' | 'Json'

Format of the exported file.

Format of the exported file

compressionFormat'None' | 'Zip'

FileResponse compression format

FileResponse compression format. None or Zip.

fileNamestring string

string

Example:filename.txt

Name of your file including extension.

Response

Accepted

Linkstring string

Direct URL to the exported file

PublicExportIDstring guid

ID of the exported file

Example response

{
  "PublicExportID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F"
}