List Autotune

GET /console/v1/autotunes

Try it

List Autotune

cURL

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

200

{
  "message": "Autotune Experiments listed successfully.",
  "data": [
    {
      "id": "test_autotune_exp",
      "name": "test_autotune_exp",
      "description": "dsdsdsd test",
      "idType": "userID",
      "lastModifierID": "24hiIXz1maFaDwtYEetv2i",
      "lastModifiedTime": 1716324033128,
      "lastModifierName": "jairo Garciga",
      "lastModifierEmail": "[e-mail]",
      "creatorID": "5sgBiiuoBX4fscrWdCXVma",
      "createdTime": 1688072516890,
      "creatorName": "Samuel Kitono",
      "creatorEmail": "[e-mail]",
      "targetApps": [],
      "holdoutIDs": [],
      "tags": [],
      "team": null,
      "isStarted": false,
      "variants": [
        {
          "name": "test_12",
          "id": "7eOW6aXU7F07KxrggOrAdy",
          "json": {
            "user": {
              "id": 12345,
              "name": "Jane Doe",
              "email": "[e-mail]",
              "isActive": true,
              "roles": [
                "admin",
                "editor",
                "subscriber"
              ]
            },
            "posts": [
              {
                "id": 1,
                "title": "Introduction to JSON5",
                "content": "JSON5 is a superset of JSON that aims to be easier for humans to write and maintain.",
                "tags": [
                  "json5",
                  "json",
                  "javascript"
                ],
                "comments": [
                  {
                    "id": 101,
                    "author": "John Smith",
                    "content": "Great post! Very informative.",
                    "likes": 5
                  },
                  {
                    "id": 102,
                    "author": "Alice Johnson",
                    "content": "I found this very helpful. Thanks!",
                    "likes": 3
                  }
                ]
              },
              {
                "id": 2,
                "title": "Advanced JSON5 Features",
                "content": "Explore the advanced features of JSON5, including comments, trailing commas, and more.",
                "tags": [
                  "json5",
                  "advanced",
                  "features"
                ],
                "comments": [
                  {
                    "id": 201,
                    "author": "Bob Brown",
                    "content": "I didn't know JSON5 could do this. Amazing!",
                    "likes": 8
                  }
                ]
              }
            ],
            "settings": {
              "theme": "dark",
              "notificationsEnabled": true,
              "language": "en-US",
              "layout": {
                "header": true,
                "footer": true,
                "sidebar": "collapsed"
              }
            },
            "metadata": {
              "version": "1.0.0",
              "author": "Jane Doe",
              "lastUpdated": "2024-05-21T10:00:00Z"
            }
          }
        },
        {
          "name": "var1",
          "id": "7eOW6cCWzX9C3WZbRWndwA",
          "json": {}
        },
        {
          "name": "control",
          "id": "7GVLLJOBETDYXLn00FXFuQ",
          "json": {}
        }
      ],
      "successEvent": "add_to_cart",
      "successEventValue": "",
      "explorationWindow": "24hrs",
      "attributionWindow": "2hrs",
      "winnerThreshold": "95%",
      "winner": null
    }
  ],
  "pagination": {
    "itemsPerPage": 100,
    "pageNumber": 1,
    "totalItems": 1,
    "nextPage": null,
    "previousPage": null,
    "all": "/console/v1/autotunes"
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Query Parameters

limit · integer

Results per page

Example:

10

page · integer

Page number

Example:

1

Response

200 - application/json

Autotune Experiments listed successfully.

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

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. 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, 1, 24, 48, 1hrs, 24hrs, 48hrs

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

ID

data. idType · string · required

Type of ID

data. lastModifierID · string | null · required

ID of the last modifier.

data. lastModifiedTime · number | 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 · 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. 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. 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

Version number

pagination · object · required

Pagination metadata for checking if there is next page for example.

Show child attributes

pagination. itemsPerPage · number · required

pagination. pageNumber · number · required

pagination. nextPage · string | null · required

pagination. previousPage · string | null · required

pagination. totalItems · number

pagination. all · string