REST API v4: GET subprofile emailings (drag and drop template)
A method to request a list of all mailings sent from Marketing Suite to a specific subprofile. This is an HTTP GET call to the following address:
https://api.copernica.com/v4/subprofile/{$subprofileID}/draganddrop/emailings
Don't forget to replace {$subprofileID}
by the ID of the subprofile you
want to retrieve the emailings for.
Available parameters
- type: The type of mailing between mass, individual abtest or splitrun.
- followups: Indicates if we only use follow-up mailings ("yes"), only mailings that were not the result of a follow-up ("no") or all mailings ("both"). Defaults to "both".
- mindestinations: Only retrieve mailings at least this many destinations.
- maxdestinations: Only retrieve mailings with at most this many destinations.
- fromdate: Only retrieve mailings sent after this date (YYYY-MM-DD HH:MM:SS format).
- todate: Only retrieve mailings sent before this date (YYYY-MM-DD HH:MM:SS format).
Returned fields
The method returns a JSON object containing the following information for each mailing:
- id: The ID of the mailing.
- timestamp: Timestamp of the mailing.
- template: The ID of the template that was used to send the mailing.
- subject: The subject of the mailing.
- from_address: An array containing the 'name' and 'email' address of the sender.
- destinations: Amount of destinations the mailing was sent to.
- type: Type of mailing (individual or mass).
- target: Contains the target type and the ID and type of other entities above it (for example the database a collection belongs to).
JSON example
The JSON object will contain a property 'data' with an array containing all the emailings. The JSON for a single emailing looks something like this:
Array
(
[id] => 139
[timestamp] => 2015-01-13 15:09:49
[template] => 519
[subject] => Test
[from_address] => Array
(
[name] => Copernica
[email] => support@copernica.com
)
[destinations] => 5
[type] => mass
[target] => Array
(
[type] => database
[sources] => Array
(
[0] => Array
(
[id] => 7078
[type] => database
)
[1] => Array
(
[id] => 7616
[type] => database
)
)
)
)
PHP Example
The following script demonstrates how to use this method. Because we use the CopernicaRestApi class, you don't have to worry about escaping special characters in the URL; it is done automatically.
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// do the call, and print result
print_r($api->get("subprofile/{$subprofileID}/draganddrop/emailings", array()));
The example above requires the CopernicaRestApi class.