REST API v2: GET statistics (Publisher mailing)

Je kunt de statistieken van een Publisher mailing opvragen door een HTTP GET request te sturen naar de volgende URL:

https://api.copernica.com/v2/publisher/emailing/$id/statistics?access_token=xxxx

Hier moet $id vervangen worden door de ID van de mailing.

Beschikbare parameters

  • begintime: Start datum (en tijd) voor de statistieken (YYYY-MM-DD HH:MM:SS formaat).
  • endtime: Eind datum (en tijd) voor de statistieken (YYYY-MM-DD HH:MM:SS formaat).

Teruggegeven waarde

Velden

Het JSON object bevat de volgende velden:

  • abuses: Array met de velden 'total' en 'unique' voor het aantal kliks en het aantal unieke abuses respectievelijk.
  • clicks: Array met de velden 'total' en 'unique' voor het aantal kliks en het aantal unieke kliks respectievelijk.
  • errors: Array met de velden 'total' en 'unique' voor het aantal kliks en het aantal unieke errors respectievelijk.
  • impressions: Array met de velden 'total' en 'unique' voor het aantal impressies en het aantal unieke impressies respectievelijk.
  • unsubscribes: Array met de velden 'total' en 'unique' voor het aantal kliks en het aantal unieke unsubscribes respectievelijk.
  • unknown: Array met het velden 'total' voor de statistieken die niet binnen de bovenstaande categorieën vallen.

Voorbeeld

Hieronder vind je een voorbeeld van zo'n JSON object:

Array
(
    [abuses] => Array
        (
            [total] => 0
            [unique] => 0
        )

    [clicks] => Array
        (
            [total] => 2
            [unique] => 1
        )

    [errors] => Array
        (
            [total] => 0
            [unique] => 0
        )

    [impressions] => Array
        (
            [total] => 4
            [unique] => 4
        )

    [unsubscribes] => Array
        (
            [total] => 1
            [unique] => 1
        )

    [unknown] => Array
        (
            [total] => 0
        )

)

PHP voorbeeld

Het volgende script demonstreert hoe je deze API methode kunt gebruiken:

// vereiste scripts
require_once('copernica_rest_api.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 2);

// stel de periode in
$data = array(
    'begintime' => "2019-01-01 00:00:00", 
    'endtime'   => "2019-02-01 00:00:00"
);

// voer het verzoek uit
print_r($api->get("publisher/emailing/{$emailingID}/statistics/", $data));

Dit voorbeeld vereist de REST API klasse.

Meer informatie