Skip to content

Latest commit



74 lines (54 loc) · 2.43 KB

File metadata and controls

74 lines (54 loc) · 2.43 KB

REST API: GET destination/message deliveries (Marketing Suite)

Each emailing is tracked, which allows Copernica to provide you with emailing statistics. Deliveries are one of these statistics. You can retrieve all deliveries for a specific destination by sending an HTTP GET call to the following URL:{$destinationID}/deliveries

Note: The terms 'destination' and 'message' can be used interchangeably in this article, including the code examples.


The parameters for this method can be set to retrieve the statistics from a certain period. The following optional parameters are available:

  • begintime: The timestamp after which the deliveries must have occurred (YYYY-MM-DD HH:MM:SS format).
  • endtime: The timestamp before which the deliveries must have occurred (YYYY-MM-DD HH:MM:SS format).

Returned fields

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

  • ID: The ID of the delivery.
  • mailing: The ID of the mailing.
  • timestamp: The timestamp of delivery.
  • attempts: Number of attempts made before the delivery.
  • destination: The ID of the destination that was delivered to.
  • profile: The ID of the profile that was delivered to.
  • subprofile: The ID of the subprofile that was delivered to.

JSON example

A single delivery might look something like this:

   "timestamp":"2014-11-06 13:43:17",

PHP example

This script demonstrates how to use this API method:

// dependencies

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

// execute the call

This example requires the REST API class.

More information