REST API v2: GET deliveries (Publisher destination)

Net zoals je van een mailing statistieken op kunt vragen kun je ook de statistieken per emailing destination opvragen. Je kan deze opvragen met een HTTP GET call naar de volgende URL:

https://api.copernica.com/v2/publisher/destination/$id/deliveries?access_token=xxxx

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

Teruggegeven velden

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

  • ID: De ID van de delivery.
  • timestamp: De tijdstempel van de delivery.
  • attempt: De attempt van de delivery.
  • smtp-response: De beschrijving van de delivery zoals ontvangen van de SMTP server.
  • emailing: De ID van de afgeleverde mailing.
  • destination: De ID van de destination.
  • profile: De ID van het profiel waaraan het bericht geleverd is.
  • subprofile: De ID van het subprofiel waaraan het bericht geleverd is (als deze beschikbaar is).

JSON voorbeeld

De JSON voor een enkele delivery ziet er bijvoorbeeld zo uit:

{  
   "ID":"1",
   "timestamp":"2010-01-04 12:17:51",
   "attempt":"0",
   "smtp-response":"test",
   "emailing":"671",
   "destination":"57092",
   "profile":"2384041",
   "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", 2);

// 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/destination/{$destinationID}/deliveries/", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie