Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

REST API: GET destinations (Publisher mailing)

You can retrieve the destinations for an emailing by sending an HTTP GET call to the following URL:

https://api.copernica.com/v3/publisher/emailing/$id/destinations?access_token=xxxx

Where the $id should be replaced with the ID of the emailing. This method also support the use of the fields parameter for the timestampsent field.

Returned fields

The method returns a JSON object with several destinations. For each destination the following information is available:

  • ID: The ID of the destination.
  • timestampsent: The timestamp on which the mailing was sent to this recipient.
  • internal: The internal ID of the destination.
  • profile: The ID of the profile of the destination.
  • subprofile: The ID of the subprofile of the destination (if applicable).
  • mailing: The ID of the mailing.

JSON example

The JSON for a single destination might look something like this:

{  
   "ID":"56ed14bf71f7bc4e200e712e646ed32f",
   "timestampsent":"2014-08-26 10:14:15",
   "internal":"802345",
   "profile":"9180926",
   "subprofile":null,
   "mailing":"42913"
}

PHP example

This script demonstrates how to use this API method:

// dependencies
require_once('copernica_rest_api.php');

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 3);

// execute the call
print_r($api->get("publisher/emailing/{$emailingID}/destinations/"));

This example requires the REST API class.

More information