REST API v4: GET unsubscribes (HTML mailing destination)
You can retrieve the statistics per emailing destination just like you would retrieve the statistics of a mailing. You can retrieve the unsubscribes for an emailing destination by sending an HTTP GET call to the following URL:
https://api.copernica.com/v4/html/destination/$id/unsubscribes
Where the $id
should be replaced with the ID of the emailing destination. This method
also support the use of the fields parameter
for the timestamp field.
Returned fields
The method returns a JSON object with several unsubscribes in the 'data' field. For each unsubscribe the following information is available:
- ID: The ID of the unsubscribe.
- timestamp: The timestamp of the unsubscribe.
- source: The source of the unsubscribe: Either from a link or an email.
- success: Whether the unsubscribe was successful or not.
- emailing: The ID of the emailing.
- destination: The ID of the destination.
- profile: The ID of the profile.
- subprofile: The ID of the subprofile (if applicable).
JSON example
A single unsubscribe might look something like this:
{
"ID":"1",
"timestamp":"2011-11-09 12:42:35",
"source":"link",
"success":true,
"emailing":"42341",
"destination":"847259",
"profile":"5063195",
"subprofile":null
}
PHP example
This script demonstrates how to use this API method:
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// set the period
$parameters = array(
'fields' => array('timestamp>2019-01-01', 'timestamp<2019-02-01')
);
// execute the call
print_r($api->get("html/destination/{$destinationID}/unsubscribes/", $parameters));
This example requires the REST API class.