Skip to content

Configure Split Test

Tool name: configure-newsletter-split-test

Configures an email newsletter split test's audience share, measuring period and winner criterion. Omitted settings stay unchanged. Conversions and revenue require the conversion pixel; opens and clicks do not. Refused after the test starts; sends nothing.

Input schema

campaignIdinteger, >= 1required

ID of the split test campaign whose settings to write

testSizePercentnull or integer, [ 2 .. 98 ]

Share of the audience the variants go to, 2 to 98; omit to keep

Default:null
testDurationHoursnull or integer, [ 1 .. 27777 ]

Measuring period before the winner goes to the rest, 1 to 27777 hours; omit to keep

Default:null
winnerBynull or string

"opens" (open rate), "clicks" (unique clicks), "conversions" or "revenue" (both need the conversion pixel); omit to keep

Default:null
Enum:"opens""clicks""conversions""revenue"
accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{ "campaignId": 1, "testSizePercent": null, "testDurationHours": null, "winnerBy": "opens", "accountId": null }

Output schema

accountIdintegerrequired
newsletterIdintegerrequired
variantsArray of objectsrequired
variantCountintegerrequired
needsMoreVariantsbooleanrequired
sharePerVariantPercentintegerrequired
testSizePercentintegerrequired
testDurationHoursintegerrequired
winnerBystring or nullrequired
hasStartedbooleanrequired
Output example
{ "accountId": 0, "newsletterId": 0, "variants": [ { "emailId": 0, "label": "string", "name": "string", "subject": "string", "editorUrl": "string", "contentRevision": "string" } ], "variantCount": 0, "needsMoreVariants": true, "sharePerVariantPercent": 0, "testSizePercent": 0, "testDurationHours": 0, "winnerBy": "string", "hasStarted": true }