REST API v4: GET abuses (HTML mailing destination)
You can retrieve the statistics per emailing destination just like you would retrieve the statistics of a mailing. You can retrieve the abuses for an emailing destination by sending an HTTP GET call to the following URL:
https://api.copernica.com/v4/html/destination/$id/abuses
Where the $id
should be replaced with the ID of the emailing destination. 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' field. For each abuse the following information is available:
- ID: ID of the abuse.
- timestamp: Timestamp of the abuse.
- recognized_as: What the abuse was recognized as ('arf', 'JMR', 'none').
- feedback_type: The type of feedback for the abuse ('abuse', 'dkim', 'fraud', 'miscategorized', 'not-spam', 'opt-out' or 'other')
- arf_version: Version of the ARF protocol used for this abuse.
- details: The abuse report (if available).
- emailing: ID of the emailing.
- destination: ID of the destination.
- profile: ID of the profile.
- subprofile: ID of the subprofile (if applicable)
JSON example
A single abuse might look something like this:
{
"ID":"2",
"timestamp":"2009-12-01 10:00:00",
"recognized_as":"arf",
"feedback_type":"opt-out",
"arf_version":"0.1",
"details":"",
"emailing":"613",
"destination":"60716",
"profile":"2231853",
"subprofile":null
}
PHP example
This script demonstrates how to use this API method:
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// set the period
$parameters = array(
'fields' => array('timestamp>2019-01-01', 'timestamp<2019-02-01')
);
// execute the call
print_r($api->get("html/destination/{$destinationID}/abuses/", $parameters));
This example requires the REST API class.
More information
- Overview of all REST API calls
- Retrieve an HTML emailing destination
- Get clicks for an HTML emailing destination
- Get deliveries for an HTML emailing destination
- Get errors for an HTML emailing destination
- Get impressions for an HTML emailing destination
- Get unsubscribes for an HTML emailing destination