ITiterable
experiments

Create an experiment

Changed on

Creates a <code>draft</code> experiment on a campaign. The campaign's current template becomes the control variant. This request doesn't add variants, configure settings, or start the experiment. If you omit <code>name</code>, Iterable names the experiment <code>{campaign name} Experiment</code>. You can create experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. You can't use this endpoint to create send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.

post/api/experiments

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

campaignIdinteger required

ID of the campaign to attach the experiment to

experimentType'SubjectLine' | 'PreheaderText' | 'FromNameAndSender' | 'EmailBody' | 'WholeEmail' required

What the experiment tests. <code>SubjectLine</code>, <code>PreheaderText</code>, <code>FromNameAndSender</code>, and <code>EmailBody</code> are available only for email campaigns. <code>WholeEmail</code> tests all of a message's content and is available for every channel.

namestring

Optional display name. If omitted, Iterable uses <code>{campaign name} Experiment</code>.

Response

Experiment created

allocationModestring required

Traffic allocation mode

channelType'email' | 'push' | 'sms' | 'in_app' | 'web_push' required

Channel type for the experiment.

creationDatestring date-time

Date the experiment was created

experimentTypestring required

Experiment type

finishDatestring date-time

End date of the experiment

idinteger required

Experiment ID

startDatestring date-time

Start date of the experiment

status'draft' | 'ready' | 'running' | 'finished' | 'winner_found' required

Experiment status

Changes