REST API v4: POST splitrun (Drag and drop)
Een splitrun emailing is een emailing waarbij meerdere templates naar verschillende testgroepen worden verstuurd. Nadat de testgroepen voldoende tijd hebben gehad om resultaten te verzamelen, wordt het best presterende template automatisch naar de resterende doelgroep verstuurd.
Je kunt de REST API gebruiken om een splitrun emailing voor de Marketing Suite aan te maken door een HTTP POST-verzoek te versturen naar de volgende URL:
https://api.copernica.com/v4/draganddrop/splitrun
Parameters
De methode accepteert de volgende parameters:
- targettype: Type van de doelgroep (
database,collection,view,miniview,profileofsubprofile). - target: ID van de doelgroep.
- templates: Array met de ID's van minimaal twee emailing templates die met elkaar vergeleken worden.
- testpercentage: Percentage van de doelgroep dat gebruikt wordt voor de testgroepen (tussen 0 en 100). Dit percentage wordt gelijk verdeeld over de templates.
- criterion: Criterium waarmee het winnende template wordt bepaald.
Mogelijke waarden zijn
opens(aantal unieke opens) enclicks(aantal unieke clicks). - delay: Tijdsduur die gewacht wordt voordat het winnende template naar de resterende doelgroep wordt verstuurd. De waarde moet een ISO 8601-duration bevatten.
- start: Tijdstip waarop de emailing moet starten (
YYYY-MM-DD HH:MM:SSformaat). - rrule: RRule-specificatie voor herhaling (optioneel).
- messagesperminute: Maximaal aantal berichten dat per minuut verstuurd wordt (optioneel).
RRules
Een RRule is een regel die herhaling specificeert, bijvoorbeeld voor een maandelijkse mailing. De RRules die binnen Copernica gebruikt worden volgen het iCalendar-formaat (RFC 5545).
Er bestaan verschillende tools om je op weg te helpen met RRules, zoals de RRule-tool op de iCalendar-website.
Als je geen RRule meegeeft, wordt de mailing slechts één keer verzonden.
JSON voorbeeld
De volgende JSON demonstreert hoe je de API-methode kunt gebruiken:
{
"targettype": "database",
"target": 1234,
"templates": [123, 124, 125],
"testpercentage": 20,
"criterion": "opens",
"delay": "PT24H",
"start": "2026-07-01 12:00:00",
"messagesperminute": 1000,
"rrule": "FREQ=DAILY;COUNT=2"
}
In dit voorbeeld wordt 20% van de doelgroep gelijk verdeeld over drie testgroepen. Na 24 uur wordt bepaald welk template de meeste unieke opens heeft behaald. Het winnende template wordt vervolgens naar de resterende 80% van de doelgroep verstuurd.
PHP voorbeeld
Het onderstaande script demonstreert hoe je deze API-methode gebruikt.
// vereiste scripts
require_once('CopernicaRestAPI.php');
// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 4);
// stel de data voor het verzoek in
$data = array(
'targettype' => "database",
'target' => 1234,
'templates' => array(123, 124, 125),
'testpercentage' => 20,
'criterion' => "opens",
'delay' => "PT24H",
'start' => "2026-07-01 12:00:00",
'messagesperminute' => 1000,
'rrule' => "FREQ=DAILY;COUNT=2"
);
// voer het verzoek uit
print_r($api->post("draganddrop/splitrun", $data));
Dit voorbeeld vereist de REST API-klasse.
Meer informatie
- Overzicht van alle REST API-calls
- Vraag alle Marketing Suite mailings op
- Vraag alle Marketing Suite scheduled mailings op
- Aanmaken van een Marketing Suite emailing
De volgende links helpen je op weg met RRules. Deze pagina's zijn geschreven in het Engels.