POST
/
console
/
v1
/
autotunes
/
{id}
curl --request POST \
  --url https://statsigapi.net/console/v1/autotunes/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '{
  "id": "my_autotunes_are_best",
  "isStarted": false,
  "description": "helpful summary of what this Autotune is",
  "lastModifierID": "ahKwUoaNauHu9AmJPc2",
  "lastModifierName": "CONSOLE API",
  "variants": [
    {
      "name": "red",
      "json": {
        "foo": "boo"
      }
    },
    {
      "name": "blue",
      "json": {}
    }
  ],
  "successEvent": "purchase_item",
  "successEventValue": "",
  "explorationWindow": "1hr",
  "attributionWindow": "2hrs",
  "winnerThreshold": "99%",
  "idType": "userID"
}'
{
  "message": "Autotune Experiment read successfully.",
  "data": {
    "id": "my_autotunes_are_best",
    "isStarted": false,
    "description": "helpful summary of what this Autotune is",
    "lastModifierID": "jd93DGSnvkauH9FijdGiajh",
    "lastModifierName": "CONSOLE API",
    "variants": [
      {
        "name": "red",
        "json": {
          "color": "red"
        }
      },
      {
        "name": "blue",
        "json": {
          "color": "blue"
        }
      }
    ],
    "successEvent": "purchase_item",
    "successEventValue": "",
    "explorationWindow": "1hr",
    "attributionWindow": "2hrs",
    "winnerThreshold": "99%"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Path Parameters

​
id
string
required

id

Body

application/json

Autotune object

​
variants
object[]
required

An array of Variant objects.

An array of Variant objects

​
successEvent
string
required

The event you are trying to optimize for.

​
explorationWindow
enum<string>
required

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

Available options:
1hr,
24hr,
48hr,
1,
24,
48,
1hrs,
24hrs,
48hrs
​
attributionWindow
enum<string>
required

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

Available options:
1hr,
2hr,
4hr,
24hr,
1hrs,
2hrs,
4hrs,
24hrs,
1,
2,
4,
24
​
winnerThreshold
enum<string>
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.

Available options:
80%,
90%,
95%,
98%,
99%
​
description
string

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

​
successEventValue
string

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

​
metadataField
string

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.

​
higherIsBetter
boolean

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

Response

200
application/json
Fully Update Autotune Success
​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.