REST API v4: GET statistics (HTML mailing)

You can retrieve the statistics of an HTML mailing by sending an HTTP GET request to the following URL:

https://api.copernica.com/v4/html/emailing/$id/statistics

Where the $id should be replaced with the ID of the mailing.

Available parameters

  • begintime: Start date (and time) for the statistics (YYYY-MM-DD HH:MM:SS format).
  • endtime: End date (and time) for the statistics (YYYY-MM-DD HH:MM:SS format).

Return value

Fields

The following fields are available in the JSON object:

  • abuses: An array with fields 'total' and 'unique' for the total number of clicks and number of unique clicks respectively.
  • clicks: An array with fields 'total' and 'unique' for the total number of clicks and number of unique clicks respectively.
  • errors: An array with fields 'total' and 'unique' for the total number of clicks and number of unique clicks respectively.
  • impressions: An array with fields 'total' and 'unique' for the total number of clicks and number of unique clicks respectively.
  • unsubscribes: An array with fields 'total' and 'unique' for the total number of clicks and number of unique clicks respectively.
  • unknown: An array with the field 'total' for all of the statistics not fitting the categories above.
  • dominant_results: Array with the dominant result.

Example

The JSON output will look something like this:

{
    "destinations": 10,
    "deliveries": {
        "total": 10
    },
    "errors": {
        "total": 1,
        "unique": 1
    },
    "impressions": {
        "total": 4,
        "unique": 3
    },
    "clicks": {
        "total": 2,
        "unique": 2
    },
    "unsubscribes": {
        "total": 0,
        "unique": 0
    },
    "abuses": {
        "total": 0,
        "unique": 0
    },
    "unknown": {
        "total": 0
    },
    "dominant_results": {
        "destinations": 10,
        "errors": 1,
        "abuses": 0,
        "unsubscribes": 0,
        "clicks": 2,
        "impressions": 2,
        "deliveries": 0
    }
}

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
$data = array(
    'begintime' => "2019-01-01 00:00:00", 
    'endtime'   => "2019-02-01 00:00:00"
);

// execute the call
print_r($api->get("html/emailing/{$emailingID}/statistics/", $data));

This example requires the REST API class.

More information