Data Export Quick Transactional

This service allows export of data for transactional emails. It is separate from the other Data Export services in that it does not rely on a data_export node. Instead the reports are generated and immediately using the #filter provided.

There are a variety of reports available, but only one is fully described below, as they all use the same format of parameters and return values.

Each method generates a CSV file which can then be downloaded. The columns in the CSV will be similar, but some additional columns will be available for particular report types, such as click-through URL.

sent

string data_export_quick_transactional.sent( array filter )

Generates the chosen report, based upon the filter provided.

Parameters

filter

Associative array, optionally containing any of the keys detailed below:

Key	Type	Description
dateFrom	string	Only export data from emails sent from and including this date (yyyy-mm-dd). Default to -28 days
dateTo	string	Only export data from emails sent up to and including this date (yyyy-mm-dd). Default to today
fromAddress	array	Indexed array of fromAddress IDs for which to include data
tags	string	Indexed array of tag names for which to include data
timestamp	string	Only export events from and including this datetime (yyyy-mm-dd HH:mm:ss)

fromAddress IDs and tags can be found from the transactional service.

Return Values

Returns the file download key.

The method will only return once the file has been successfully generated, or return an error. There is no need to check for export creation status as there is with some other export services.

The file can downloaded by using the following URL:

https://<server>/download/file/key/<key>

Where:

Placeholder	Value
server	Hostname of your server
key	The file download key returned