Data Export Quick
This service allows export of data for campaign emails. It is separate from other Data Export services, in that it does not rely on a data_export node. Instead the reports are generated immediately using the #filter provided.
There are a variety of reports available, but only two are fully described below, as most 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 or conversion revenue.
sent
string data_export_quick.sent( array filter )Generates the chosen report, based upon the filter provided.
Parameters
filter
Associative array, containing at least one of the keys detailed below:
Key | Type | Description |
|---|---|---|
email_id | int | Identifier for the email from which to export data |
timestamp | string | Only export data from after this DateTime (yyyy-mm-dd hh:mm:ss), maximum age 1 month |
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 |
delivered
Uses the same format of parameters and return values as #sent.
bounced
Uses the same format of parameters and return values as #sent.
opened
Uses the same format of parameters and return values as #sent.
totalOpens
Uses the same format of parameters and return values as #sent.
clicked
Uses the same format of parameters and return values as #sent.
totalClicks
Uses the same format of parameters and return values as #sent.
responded
Uses the same format of parameters and return values as #sent.
unsubscribed
Uses the same format of parameters and return values as #sent.
converted
Uses the same format of parameters and return values as #sent.
totalConversions
Uses the same format of parameters and return values as #sent.
unsubscribeFeedback
string data_export_quick.unsubscribeFeedback( array filter )Designed for use in situations where unsubscribes are being managed outside the system, but you still want to extract the feedback unsubscribes that the system receives from ISPs.
Generates the chosen report, based upon the filter provided.
Parameters
filter
Associative array, optionally containing any of the keys detailed below:
Key | Type | Description |
|---|---|---|
timestamp | string | Only export data from after this DateTime |
Return Values
Uses the same format of return values as #return values as sent.
Service
data_export_quick
Methods