v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Autotunes

Create Autotune

post/console/v1/autotunes

Request body

descriptionstring

A brief summary of what the autotune is being used for.

successEventstring required

The event you are trying to optimize for.

successEventValuestring

The value that should come with the event for it to be considered successful.

explorationWindow'1hr' | '24hr' | '48hr' | '168hr' | '336hr' | '1' | '24' | '48' | '168' | '336' | '1hrs' | '24hrs' | '48hrs' | '168hrs' | '336hrs' required

The initial time period where Autotune will equally split the traffic.

attributionWindow'1hr' | '2hr' | '4hr' | '24hr' | '1hrs' | '2hrs' | '4hrs' | '24hrs' | '1' | '2' | '4' | '24' required

The maximum duration between the exposure and success event that counts as a success.

attributionWindowUnit'min' | 'hour' | 'day'

Time unit of attribution window

explorationWindowRatenumber double

Exploration window rate

longtermExplorationAllocationnumber double

Long term exploration allocation

winnerThreshold'80%' | '90%' | '95%' | '98%' | '99%' required

The "probability of best" threshold a variant needs to achieve for Autotune to declare it the winner, stop collecting data, and direct all traffic.

metadataFieldstring

Metadata field containing the numeric value to optimize for. If this field is null, autotune optimizes for the existence of a follow-up event. This is only used for contextual autotunes.

higherIsBetterboolean

Whether to optimize for an increase or decrease in the metadata field value. Default is true. This is only used for contextual autotunes.

isContextualboolean

Makes this autotune contextual

metricSourceIDstring

Metric source to pull success event data from

linkedExperimentNamestring

Linked experiment to measure the success of the Autotune

goalRichTextstring

Autotune goal

optimizationParameter'occurrence' | 'value'

Optimize for event occurrence vs value

valueColumnstring

Metric source column to optimize for

featureListstring[]

List of features that should be included in the analysis

namestring required

The name that was originally given to the autotune on creation but formatted as an ID ("A Autotune" -> "a_autotune").

idTypestring

idType of the autotune (userID, stableID, or a customID). Defaults to userID if not provided

Response

Create Autotune Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Autotune Experiments created successfully.",
  "data": {
    "id": "button_color_test",
    "isStarted": false,
    "description": "Which color button gets the most clicks.",
    "lastModifierID": "ajv762klv9nx9hca",
    "lastModifierName": "CONSOLE API",
    "inlineTargetingRulesJSON": "{}",
    "inlineTargetingRules": [],
    "variants": [
      {
        "name": "red",
        "json": {
          "color": "red"
        }
      },
      {
        "name": "blue",
        "json": {
          "color": "blue"
        }
      }
    ],
    "successEvent": "click",
    "successEventValue": "",
    "explorationWindow": "1hr",
    "attributionWindow": "2hrs",
    "winnerThreshold": "99%"
  }
}