REST API v2: GET abuses (Publisher mailing)

Er worden statistieken bijgehouden over elke mailing die verstuurd wordt met Copernica om je meer inzicht te geven in de prestatie hiervan. Abuses zijn een van de statistieken die voor een mailing worden bijgehouden. Je kan deze opvragen met een HTTP GET call naar de volgende URL:

https://api.copernica.com/v2/publisher/emailing/$id/abuses?access_token=xxxx

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

Teruggegeven velden

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

  • ID: ID van de abuse.
  • timestamp: Tijdstempel van de abuse.
  • recognized_as: Herkende soort van de abuse ('arf', 'JMR', 'none').
  • feedback_type: Type feedback van de abuse ('abuse', 'dkim', 'fraud', 'miscategorized', 'not-spam', 'opt-out' or 'other')
  • arf_version: Versie van het ARF protocol gebruikt voor deze abuse.
  • details: Het abuse report (als deze beschikbaar is).
  • emailing: ID van de emailing.
  • destination: ID van de destination.
  • profile: ID van het profiel.
  • subprofile: ID van het subprofiel (als deze beschikbaar is)

JSON voorbeeld

Een enkele abuse ziet er bijvoorbeeld zo uit:

{  
   "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 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/emailing/{$emailingID}/abuses/", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie