experiments

Declare a winner and end experiment

Changed on

Declares the variant you specify as the winner of a <code>running</code> experiment, and then ends the experiment. If the experiment already has a winner (<code>winner_found</code>), the variant you specify replaces it. Iterable replaces the campaign's template with the winning variant's template. You can't declare the holdout group as the winner, and you can't change the winner after the experiment ends. This endpoint works only with experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. It doesn't work with send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.

post/api/experiments/{experimentId}/winner

Request

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

Path parameters

experimentIdinteger required

Experiment ID

Request body

variantIdinteger required

ID of the variant to declare as the winner. The holdout group cannot be selected.

Response

Winner declared

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