Read Autotune

Read Autotune

curl --request GET \
  --url https://statsigapi.net/console/v1/autotunes/{id} \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "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": {
          "foo": "boo"
        }
      },
      {
        "name": "blue",
        "json": {}
      }
    ],
    "successEvent": "purchase_item",
    "successEventValue": "",
    "explorationWindow": "1hr",
    "attributionWindow": "2hrs",
    "winnerThreshold": "99%"
  }
}

GET

console

autotunes

{id}

Read Autotune

curl --request GET \
  --url https://statsigapi.net/console/v1/autotunes/{id} \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "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": {
          "foo": "boo"
        }
      },
      {
        "name": "blue",
        "json": {}
      }
    ],
    "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

string

required

Response

Read Autotune Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

data.description

string

required

Detailed description of the configuration’s purpose.

data.variants

object[]

required

Show child attributes

data.variants.name

string

required

Variant name

data.variants.json

any

required

Variant JSON data

data.variants.id

string

required

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

data.variants.size

number

Variant size

data.successEvent

string

required

The event you are trying to optimize for.

data.successEventValue

string

required

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

data.explorationWindow

enum<string>

required

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

Available options:

1hr,

24hr,

48hr,

168hr,

336hr,

1,

24,

48,

168,

336,

1hrs,

24hrs,

48hrs,

168hrs,

336hrs

data.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

data.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%

data.id

string

required

data.idType

string

required

Type of ID

data.lastModifierID

string | null

required

ID of the last modifier.

data.lastModifiedTime

number<double> | null

required

Time of the last modification.

data.lastModifierEmail

string | null

required

Email of the last modifier.

data.lastModifierName

string | null

required

Name of the last modifier.

data.creatorID

string | null

required

ID of the user who created the entity.

data.createdTime

number<double>

required

Timestamp when the entity was created.

data.creatorName

string | null

required

Name of the creator.

data.creatorEmail

string | null

required

Email of the creator.

data.isStarted

boolean

required

Is the autotune experiment currently running.

data.winner

object

required

Show child attributes

data.winner.id

string

required

The Statsig UserID of the last modifier of this autotune.

data.winner.name

string

required

The Statsig Username of the last modifier of this autotune.

data.attributionWindowUnit

enum<string>

Time unit of attribution window

Available options:

min,

hour,

day

data.explorationWindowRate

number<double>

Exploration window rate

Required range: 0.001 <= x <= 1

data.longtermExplorationAllocation

number<double>

Long term exploration allocation

Required range: 0.001 <= x <= 1

data.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.

data.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.

data.isContextual

boolean

Whether this is a contextual autotune

data.metricSourceID

string

Metric source to pull success event data from

data.linkedExperimentName

string

Linked experiment to measure the success of the Autotune

data.goalRichText

string

Autotune goal

data.optimizationParameter

enum<string>

Optimize for event occurrence vs value

Available options:

occurrence,

value

data.valueColumn

string

Metric source column to optimize for

data.featureList

string[]

List of features that should be included in the analysis

data.name

string

Optional name for the configuration.

data.tags

string[]

Optional tags for categorization.

data.targetApps

string[]

List of target applications associated with this configuration.

data.holdoutIDs

string[]

Holdouts applied to this configuration.

data.team

string | null

Optional name for the responsible team.

data.teamID

string | null

Optional ID of the responsible team.

data.version

number<double>

Version number

Create Autotune

Fully Update Autotune

⌘I

SDK Quickstarts

SDK Concepts

Client SDKs

Server SDKs

AI SDKs

More SDK Methods

Console API Reference

Statsig CLI

HTTP API Reference

Authorizations

Headers

Path Parameters

Response