REST API v4: GET HTML destinations (subprofile)
You can retrieve the Publisher destinations for a subprofile by sending an HTTP GET call to the following URL:
https://api.copernica.com/v4/subprofile/$id/html/destinations
Where the $id
should be replaced with the ID of the subprofile. 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('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// execute the call
print_r($api->get("subprofile/{$subprofileID}/html/destinations/"));
This example requires the REST API class.