REST API: GET emailing abuses (Marketing Suite)

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

https://api.copernica.com/v2/ms/emailing/{$emailingID}/abuses?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 several abuses under the 'data' property. For each abuse the following information is available:

  • ID: The ID of the abuse.
  • mailing: The ID of the mailing.
  • timestamp: Timestamp of the abuse.
  • report: The abuse report.
  • destination: The ID of the destination that reported the abuse.
  • profile: The ID of the profile that reported the abuse.
  • subprofile: The ID of the subprofile that reported the abuse.

JSON example

A single abuse might look something like this:

{  
   "ID":"12",
   "mailing":"233482",
   "timestamp":"2019-03-05 14:44:52",
   "report":{  

   },
   "destination":"1264524",
   "profile":null,
   "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", 2);

// execute the call
print_r($api->get("ms/emailing/{$emailingID}/abuses"));

This example requires the REST API class.

More information