REST API v3: GET impressions (Publisher mailing)

Er worden statistieken bijgehouden over elke mailing die verstuurd wordt met Copernica om je meer inzicht te geven in de prestatie hiervan. Impressions zijn een van de statistieken die voor een mailing worden bijgehouden. Je kan deze opvragen met een HTTP GET call naar de volgende URL:

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

Hier moet $id vervangen worden door de ID van de mailing. Deze methode ondersteunt ook het gebruik van de fields parameter voor het timestamp veld.

Teruggegeven velden

Deze methode geeft een JSON object terug met impressions onder het 'data' veld. Voor elke impression is de volgende informatie beschikbaar:

  • ID: De ID van de impression.
  • timestamp: De tijdstempel van de impression.
  • ip: De IP waar de impression vandaan kwam.
  • useragent: De user agent string van de gebruiker die de mail opende.
  • device: Type apparaat waar de klik vandaan kwam ('desktop','tablet','mobile','unknown').
  • referer: De referer van de gebruiker die de mail opende.
  • emailing: De ID van de mailing.
  • destination: De ID van de destination.
  • profile: De ID van het profiel.
  • subprofile: De ID van het subprofiel (als deze beschikbaar is).

JSON voorbeeld

Een enkele impressie ziet er bijvoorbeeld zo uit:

{  
   "ID":"44807",
   "timestamp":"2010-07-20 14:34:32",
   "ip":"0.0.0.0",
   "useragent":"Microsoft Outlook 2007, WinXP",
   "device":"desktop",
   "referer":null,
   "emailing":"1328",
   "destination":"822758",
   "profile":"2590894",
   "subprofile":null
}

PHP voorbeeld

Dit script demonstreert hoe je de API methode kunt gebruiken:

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

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

// stel de periode in
$parameters = array(
    'fields'    =>  array('timestamp>2019-01-01', 'timestamp<2019-02-01')
);

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

Dit voorbeeld vereist de REST API klasse.

Meer informatie