REST API v3: GET errors (Publisher)

Each emailing is tracked, which allows Copernica to provide you with emailing statistics. Errors are one of these statistics. You can retrieve all errors by sending an HTTP GET call to the following URL:

https://api.copernica.com/v3/publisher/errors?access_token=xxxx

This method also support the use of the fields parameter for the timestamp field.

Returned fields

The method returns a JSON object with the errors stored in the 'data' field. For each error the following information is available:

  • ID: The ID of the error.
  • timestamp: The timestamp on which the error occurred.
  • errorcode: The error code.
  • description: The description of the error that was returned by the SMTP server.
  • errortype: The type of the error ('nocontent', 'nohost', 'unreachable', 'unexpected', 'error', 'mailerror', 'mailmessage', 'nodata', 'privateiprange' or 'other').
  • errortypedescription: The description of the error based on the type.
  • emailing: The ID of the emailing.
  • destination: The ID of the destination.
  • profile: The ID of the profile.
  • subprofile: The ID of the subprofile (if applicable).

JSON example

The JSON for a single error looks similar to this:

{  
   "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 example

This script demonstrates how to use this API method:

// dependencies
require_once('copernica_rest_api.php');

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 3);

// set the period
$parameters = array(
    'fields'    =>  array('timestamp>2019-01-01', 'timestamp<2019-02-01')
);

// execute the call
print_r($api->get("publisher/errors/", $parameters));

This example requires the REST API class.

More information