REST API: GET destinations (Marketing Suite)

Deze methode kan gebruikt worden als je alle destinations van Marketing Suite mailings van een bepaalde periode wilt opvragen. Door een GET request te sturen naar de volgende URL kun je deze gegevens opvragen: https://api.copernica.com/v2/ms/destinations?access_token=xxxx

Parameters

  • from: Begintijd voor het opvragen van de destinations (YYYY-MM-DD).
  • to: Eindtijd voor het opvragen van de destinations (YYYY-MM-DD).

Optionele parameters

  • Unsubscribed: Bij 'true' worden alleen profielen teruggegeven die het uitschrijfgedrag hebben getriggered.

Geretourneerde velden

Deze methode geeft een JSON object terug met de volgende data:

  • id: ID van de destination
  • messageID: Message ID van de destination
  • timestampsent: Tijdstip waarop de mailing is verzonden
  • profile: ID van het profiel die de mail heeft ontvangen
  • subprofile: ID van het subprofiel die de mail heeft ontvangen (als de destination een subprofiel was)
  • mailing: ID van de verzonden mailing
  • unsubscribed: Heeft de destination het uitschrijfgedrag getriggered?

PHP example

Het volgende PHP script demonstreert hoe je de API methode kunt aanroepen:

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

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

// parameters voor de methode
$parameters = array(
    'from'     =>  '2021-02-01',
    'to'       =>  '2021-02-02',
);

// voer methode uit en print resultaat
print_r($api->get("ms/destinations", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie