REST API v4: GET errors (HTML mailing 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/v4/html/destination/$id/errors

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 errors in een array onder het 'data' veld. Voor elke error is de volgende informatie beschikbaar:

  • ID: De ID van de error.
  • timestamp: De tijdstempel van de error.
  • errorcode: De error code.
  • description: De beschrijving van de error zoals ontvangen van de SMTP server.
  • errortype: Het type van de error ('nocontent', 'nohost', 'unreachable', 'unexpected', 'error', 'mailerror', 'mailmessage', 'nodata', 'privateiprange' or 'other').
  • errortypedescription: De omschrijving van de error gebaseerd op het type.
  • 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 error ziet er bijvoorbeeld zo uit:

{  
   "ID":"16",
   "timestamp":"2008-06-25 14:23:05",
   "errorcode":"5.1.2",
   "description":"Resolver error: no mailservers found for domain",
   "errortype":"nohost",
   "errortypedescription":"Map domain name to IP address",
   "emailing":"401",
   "destination":"54215",
   "profile":"52647",
   "subprofile":null
}

PHP voorbeeld

Dit script demonstreert hoe je de API methode kunt gebruiken:

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

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

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

// voer het verzoek uit
print_r($api->get("html/destination/{$destinationID}/errors/", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie