REST API: GET logfiles names

Copernica houdt logfiles bij over bijvoorbeeld clicks, opens, errors, ontvangen berichten, etc. Deze logfiles kunnen gedownload worden met de API of via het dashboard. Door een HTTP GET verzoek te sturen naar de volgende URL krijg je een lijst van alle bestaande logfiles voor een datum.

https://api.copernica.com/v2/logfiles?access_token=xxxx&date=$date&type=$type

In deze URL kun je twee parameters meegeven: $date kan gebruikt worden om een specifieke datum mee te geven waarvoor je de namen van de logfiles wilt zien. Hetzelfde doet $type voor het type logfile. Een overzicht daarvan vindt je in de tabel onder het kopje "Teruggegeven velden". Beide parameters zijn optioneel. Als je beide gebruikt worden de files gefilterd op zowel datum als type. Als je geen van beide gebruikt krijg je de datums waarvoor logfiles bestaan terug.

Teruggegeven velden

Deze methode geeft een JSON array terug met de namen van logfiles. De types van de logfiles staan hieronder in de tabel.

Prefix Type informatie
cdm-attempts Algemene info over mails verstuurd met Marketing Suite (MS)
cdm-abuse Info over mails verstuurd met MS die een 'misbruik' notificatie veroorzaakten
cdm-click Info over clicks in mails verstuurd via MS
cdm-delivery Info over aangekomen mails verstuurd via MS
cdm-error Info over errors in mails verstuurd via MS
cdm-impression Info over impressies uit mails verstuurd via MS
cdm-retry Info over herzonden mails verstuurd via MS
cdm-unsubscribe Info over uitschrijvingen als gevolg van een mail verstuurd via MS
pom-attempts Algemene info over mails verstuurd met Publisher
pom-abuses Info over mails verstuurd met Publisher die een misbruik' notificatie veroorzaakten
pom-clicks Info over clicks in mails verstuurd via Publisher
pom-deliveries Info over aangekomen mails verstuurd via Publisher
pom-errors Info over errors in mails verstuurd via Publisher
pom-impressions Info over impressies uit mails verstuurd via Publisher
pom-retries Info over herzonden mails verstuurd via Publisher
pom-unsubscribes Info over uitschrijvingen als gevolg van een mail verstuurd via Publisher
feedback-loop-errors Info over errors in je feedback loops

Voor meer informatie over het downloaden van deze files in het gewenste formaat kun je de documentatie onder het kopje "Meer informatie" bekijken.

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je de API methode gebruikt. Vergeet niet de datum in te voegen in de URL (YYYY-MM-DD formaat).

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

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

// de array voor de gewenste datum en/of het gewenste type van de logfiles
$parameters = array(
    'type' =>     "cdm-attempts",
    'date' =>     "2019-01-01",
);

// voer het verzoek uit en print het resultaat
print_r($api->get("logfiles", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie