REST API v4: GET emailings (HTML mailings)

Deze methode vraagt een lijst op van alle mailings verstuurd met Publisher. De methode maakt een HTTP call naar het volgende adres:

https://api.copernica.com/v4/html/emailings

Je kunt de methode om alle Marketing Suite mailings op te vragen hier vinden.

Beschikbare parameters

  • type: Het type mailing. Dit kan een massa ('mass') mailing zijn of een individuele ('individual') mailing. De methode zal standaard beide opvragen.
  • followups: Geeft aan of we alleen opvolgactie mailings ("yes") gebruiken, alleen mailings die niet het resultaat waren van een opvolgactie ("no") of alle mailings ("both"). Standaardwaarde "both".
  • test: Geeft aan of we alleen test mailings ("yes") gebruiken, alleen mailings die geen test waren ("no") of alle mailings ("both"). Standaardwaarde "both".
  • mindestinations: Vraag alleen mailings met dit minimum aantal ontvangers op.
  • maxdestinations: Vraag alleen mailings met dit maximum aantal ontvangers op.
  • fromdate: Vraag alleen mailings na deze datum op (YYYY-MM-DD HH:MM:SS formaat).
  • todate: Vraag alleen mailings voor deze datum op (YYYY-MM-DD HH:MM:SS formaat).

Deze methode ondersteunt ook paging parameters.

Teruggegeven velden

Deze methode geeft een JSON object met meerdere emailings onder het data veld. Elke mailing bevat de volgende informatie:

  • id: De ID van de mailing.
  • timestamp: De tijdstempel van de mailing.
  • document: ID van het document gebruikt voor de mailing.
  • template: ID van de template gebruikt voor de mailing.
  • subject: Onderwerp van de mailing.
  • description: Omschrijving van de mailing.
  • from_address: Afzenderadres van de mailing als een array (met 'name' en 'email' als waarden)
  • destinations: Het aantal destinations van de mailing.
  • testgroups: Het aantal testgroepen (alleen bij AB test of splitrun)
  • finalgroup: ID van de finalgroup (alleen relevant voor een splitrun mailing)
  • type: Het type van de mailing: 'mass' (massa mailing) of 'individual' (individuele mailing).
  • clicks: Aantal kliks voor deze mailing.
  • impressions: Aantal opens voor deze mailing.
  • errors: Aantal fouten voor deze mailing.
  • unsubscribes: Aantal uitschrijvingen voor deze mailing.
  • abuses: Aantal spamklachten voor deze mailing.
  • contenttype: Het type content in de mailing: 'html', 'text' of 'both' (beide).
  • target: Array die het target type en de ID en het type van zijn sources bevat (een source is bijvoorbeeld de database waartoe een collectie behoort).

JSON Voorbeeld

De JSON ziet er bijvoorbeeld zo uit:

{  
   "id":"1281",
   "timestamp":"2010-04-14 15:02:14",
   "document":"114",
   "template":"621",
   "subject":"Reminder",
   "description":"This is a reminder",
   "from_address":{  
      "name":"test",
      "email":"test@copernica.nl"
   },
   "destinations":"3",
   "testgroups":0,
   "type":"individual",
   "clicks":"5",
   "impressions":"2",   
   "errors":"0",
   "unsubscribes":"1",
   "abuses":"0",
   "contenttype":"html",
   "target":{  
      "type":"database",
      "sources":[  
         {  
            "id":"214",
            "type":"database"
         }
      ]
   }
}

PHP Voorbeeld

Het volgende script demonstreert hoe je deze methode kunt gebruiken. Omdat we de CopernicaRestAPI klasse gebruiken hoef je je geen zorgen te maken over het escapen van speciale karakters; dit wordt automatisch afgehandeld.

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

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

// parameters om aan de call mee te geven
$parameters = array(
    'limit'             => 10,
    'type'              => 'mass',
    'followups'         => 'no',
    'registerclicks'    => 'yes',
);

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

Het bovenstaande voorbeeld vereist de CopernicaRestApi klasse.

Meer informatie