SplitTest v1.2

Face off up to five different versions of a message using splitTest to get the best results possible.

What can I do with splitTest?

Get an overview of split tests performed within your account or initiate a new split test.

  • Try out different versions of your campaign to see which performs best. Try altering things like subject line, hero image, calls to action, or layout (but not all at once!).
  • Use winner_task_id on a completed test to find the winning task ID of the test.
  • Providing a delay will give subscribers a chance to interact with the sent messages, making the split test results more mature.
  • Set action to "targetwinner" if you would like the winning message sent when the test is complete and after any delay period provided.

GET /splitTest or /splitTest/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the test.
action
enumNoNoAction to be taken when initial test phase is complete: "targetwinner" or "tellme".
cancelled
boolNoNoWhether the split test is cancelled.
completed
boolYesNoWhether the split test is completed (including split tests which are tied).
criterion
enumNoNoWinning criteria for the test: "open", "click" or "goal".
delay
int/nullNoNoNumber of hours before assessing and sending the "targetwinner" action.
list_id
int/nullYesNoID of the target list.
message_ids
stringNoNoComma separated list of message IDs (Max. 5 per test).
name
stringYesYesThe test name.
scheduledtime
decimalNoYesTimestamp at which the split test is scheduled.
search_id
int/nullYesNoID of the target search; defaults to null.
segmenttype
enumNoNoMethod used to calculate the segment size: "percentage" or "number".
segmentvalue
intNoNosegmenttype's value.
size
intNoNoThe total number of recipients.
tie
boolYesNoWhether the split test is tied.
winner_task_id
int/nullNoNoWinning task ID.
cdate
decimalNoYesCreation timestamp.

A criterion value of "open" means that the winner is the task with the most opens, "click" means that the winner is the task with the most clicks, "goal" means that the winner is the task with the most goals achieved.

An action value of "targetwinner" will send the winning message to the rest of the subscribers. A value of "tellme" will do nothing.

HEAD /splitTest or /splitTest/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the test.
completed
boolOptionalWhether the split test is completed (including split tests which are tied).
list_id
int/nullOptionalID of the target list.
name
stringOptionalThe test name.
search_id
int/nullOptionalID of the target search; defaults to null.
tie
boolOptionalWhether the split test is tied.

POST /splitTest

AttributeTypePresenceDescription
id
intn/aUnique ID of the test.
action
enumRequiredAction to be taken when initial test phase is complete: "targetwinner" or "tellme".
criterion
enumRequiredWinning criteria for the test: "open", "click" or "goal".
delay
int/nullRequiredNumber of hours before assessing and sending the "targetwinner" action.
list_id
int/nullRequired*ID of the target list.
message_ids
stringRequiredComma separated list of message IDs (Max. 5 per test).
name
stringRequiredThe test name.
scheduledtime
decimalRequiredTimestamp at which the split test is scheduled.
search_id
int/nullRequired*ID of the target search; defaults to null.
segmenttype
enumRequiredMethod used to calculate the segment size: "percentage" or "number".
segmentvalue
intRequiredsegmenttype's value.

*Exactly one of: list_id, search_id must be non-null.

The delay attribute is only valid if action is "targetwinner".

A segmenttype value of "percentage" will send each message to a percentage of the list. A value of "number" will send each message to a specific number of subscribers.

segmentvalue refers to the test segment size each message should be sent to. It can be either the percentage of the target list size or a specified number of subscribers, depending on segmenttype.

PUT /splitTest or /splitTest/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the test.
cancelled
boolRequiredWhether the split test is cancelled.
delay
int/nulln/aNumber of hours before assessing and sending the "targetwinner" action.

Cancellation only works on split tests that have not started (indicated by the completed value).

DELETE /splitTest or /splitTest/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":             "123",
    "action":         "tellme",
    "cancelled":      false,
    "completed":      true,
    "criterion":      "open",
    "delay":          "null",
    "list_id":        43131,
    "message_ids":    "81986,81987",
    "name":           "API Split test test",
    "scheduledtime":  1374675750,
    "search_id":      null,
    "segmenttype":    "percentage",
    "segmentvalue":   50,
    "size":           8,
    "tie":            false,
    "winner_task_id": 81987,
    "cdate":          1374840453,
}