--- title: List Autotune description: Reference for the GET /console/v1/autotunes API endpoint. product: general token_estimate: 3643 --- # List Autotune > For AI agents: a documentation index is available at [/llms.txt](/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`. ## List Autotune **GET** `/console/v1/autotunes` Full URL: `https://statsigapi.net/console/v1/autotunes` List Autotune ## Authorizations | Name | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | STATSIG-API-KEY | string | Yes | — | apiKey (header) | ## Query parameters | Name | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | limit (query) | integer | No | 10 | Results per page Constraints: string, number | | page (query) | integer | No | 1 | Page number Constraints: string, number | ## Response (application/json) **200** — Autotune Experiments listed successfully. | Name | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | message | string | Yes | — | A simple string explaining the result of the operation. | | data | object[] | Yes | — | — | | data.description | string | Yes | — | Detailed description of the configuration’s purpose. | | data.variants | object[] | Yes | — | — | | data.variants.name | string | Yes | — | Variant name | | data.variants.json | unknown | Yes | — | Variant JSON data | | data.variants.size | number | No | — | Variant size | | data.variants.id | string | Yes | — | The name that was originally given to the autotune on creation but formatted as an ID ("A Autotune" -> "a_autotune"). | | data.successEvent | string | Yes | — | The event you are trying to optimize for. | | data.successEventValue | string | Yes | — | The value that should come with the event for it to be considered successful. | | data.explorationWindow | string | Yes | — | The initial time period where Autotune will equally split the traffic. Allowed values: 1hr, 24hr, 48hr, 168hr, 336hr, 1, 24, 48, 168, 336, 1hrs, 24hrs, 48hrs, 168hrs, 336hrs | | data.attributionWindow | string | Yes | — | The maximum duration between the exposure and success event that counts as a success. Allowed values: 1hr, 2hr, 4hr, 24hr, 1hrs, 2hrs, 4hrs, 24hrs, 1, 2, 4, 24 | | data.attributionWindowUnit | string | No | — | Time unit of attribution window Allowed values: min, hour, day | | data.explorationWindowRate | number | No | — | Exploration window rate Constraints: format: double, min: 0.001, max: 1 | | data.longtermExplorationAllocation | number | No | — | Long term exploration allocation Constraints: format: double, min: 0.001, max: 1 | | data.winnerThreshold | string | Yes | — | The "probability of best" threshold a variant needs to achieve for Autotune to declare it the winner, stop collecting data, and direct all traffic. Allowed values: 80%, 90%, 95%, 98%, 99% | | data.metadataField | string | No | — | 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 | No | — | 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 | No | — | Whether this is a contextual autotune | | data.metricSourceID | string | No | — | Metric source to pull success event data from | | data.linkedExperimentName | string | No | — | Linked experiment to measure the success of the Autotune | | data.goalRichText | string | No | — | Autotune goal | | data.optimizationParameter | string | No | — | Optimize for event occurrence vs value Allowed values: occurrence, value | | data.valueColumn | string | No | — | Metric source column to optimize for | | data.featureList | string[] | No | — | List of features that should be included in the analysis | | data.inlineTargetingRulesJSON | string | No | — | A raw JSON string of the inline targeting rules Constraints: nullable | | data.inlineTargetingRules | object[] | No | — | A formatted array of the inline targeting rules | | data.inlineTargetingRules.name | string | Yes | — | The name of this rule. | | data.inlineTargetingRules.passPercentage | number | Yes | — | Of the users that meet the conditions of this rule, what percent should return true. Constraints: min: 0, max: 100 | | data.inlineTargetingRules.conditions | object[] | Yes | — | An array of Condition objects. | | data.inlineTargetingRules.conditions.targetValue | oneOf | No | — | Constraints: nullable, string[], number[], string, number | | data.inlineTargetingRules.conditions.operator | string | No | — | — | | data.inlineTargetingRules.conditions.field | string | No | — | Constraints: nullable | | data.inlineTargetingRules.conditions.customID | string | No | — | Constraints: nullable | | data.inlineTargetingRules.conditions.type | string | Yes | — | Allowed values: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, user_agent, url, javascript, device_model, target_app, experiment_group | | data.inlineTargetingRules.environments | string[] | No | — | The environments this rule is enabled for. Constraints: nullable | | data.inlineTargetingRules.id | string | No | — | The Statsig ID of this rule. | | data.inlineTargetingRules.baseID | string | No | — | The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout | | data.inlineTargetingRules.returnValue | object | No | — | The return value of the rule. | | data.inlineTargetingRules.completedAutomatedRollouts | object[] | No | — | Read-only: Automated rollout phases that have already completed. | | data.inlineTargetingRules.completedAutomatedRollouts.time | number | No | — | — | | data.inlineTargetingRules.completedAutomatedRollouts.passPercent | number | Yes | — | — | | data.inlineTargetingRules.pendingAutomatedRollouts | object[] | No | — | Read-only: Automated rollout phases that are scheduled but not yet complete. | | data.inlineTargetingRules.pendingAutomatedRollouts.time | number | No | — | — | | data.inlineTargetingRules.pendingAutomatedRollouts.passPercent | number | Yes | — | — | | data.id | string | Yes | — | ID | | data.name | string | No | — | Optional name for the configuration. | | data.idType | string | Yes | — | Type of ID | | data.lastModifierID | string | Yes | — | ID of the last modifier. Constraints: nullable | | data.lastModifiedTime | number | Yes | — | Time of the last modification. Constraints: format: double, nullable | | data.lastModifierEmail | string | Yes | — | Email of the last modifier. Constraints: nullable | | data.lastModifierName | string | Yes | — | Name of the last modifier. Constraints: nullable | | data.creatorID | string | Yes | — | ID of the user who created the entity. Constraints: nullable | | data.createdTime | number | Yes | — | Timestamp when the entity was created. Constraints: format: double | | data.creatorName | string | Yes | — | Name of the creator. Constraints: nullable | | data.creatorEmail | string | Yes | — | Email of the creator. Constraints: nullable | | data.tags | string[] | No | — | Optional tags for categorization. | | data.targetApps | string[] | No | — | List of target applications associated with this configuration. | | data.holdoutIDs | string[] | No | — | Holdouts applied to this configuration. | | data.team | string | No | — | Optional name for the responsible team. Constraints: nullable | | data.teamID | string | No | — | Optional ID of the responsible team. Constraints: nullable | | data.version | number | No | — | Version number Constraints: format: double | | data.isStarted | boolean | Yes | — | Is the autotune experiment currently running. | | data.winner | object | Yes | — | Constraints: nullable | | data.winner.id | string | Yes | — | The Statsig ID of the winner group. | | data.winner.name | string | Yes | — | The name of the winner group. | | pagination | object | Yes | — | Pagination metadata for checking if there is next page for example. | | pagination.itemsPerPage | number | Yes | — | Constraints: format: double | | pagination.pageNumber | number | Yes | — | Constraints: format: double | | pagination.nextPage | string | Yes | — | Constraints: nullable | | pagination.previousPage | string | Yes | — | Constraints: nullable | | pagination.totalItems | number | No | — | Constraints: format: double | | pagination.all | string | No | — | — | ```json { "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": "jairo@statsig.com", "creatorID": "5sgBiiuoBX4fscrWdCXVma", "createdTime": 1688072516890, "creatorName": "Samuel Kitono", "creatorEmail": "samuel@statsig.com", "targetApps": [], "holdoutIDs": [], "tags": [], "team": null, "isStarted": false, "inlineTargetingRulesJSON": "{}", "inlineTargetingRules": [], "variants": [ { "name": "test_12", "id": "7eOW6aXU7F07KxrggOrAdy", "json": { "user": { "id": 12345, "name": "Jane Doe", "email": "jane.doe@example.com", "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" } } ``` ## Code samples ### cURL ```bash curl -X GET "https://statsigapi.net/console/v1/autotunes?limit=10&page=1" \ -H "Content-Type: application/json" \ -H "STATSIG-API-KEY: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://statsigapi.net/console/v1/autotunes?limit=10&page=1", headers={ "Content-Type": "application/json", "STATSIG-API-KEY": "YOUR_API_KEY" } ) data = response.json() ``` ### JavaScript ```javascript const response = await fetch("https://statsigapi.net/console/v1/autotunes?limit=10&page=1", { method: "GET", headers: { "Content-Type": "application/json", "STATSIG-API-KEY": "YOUR_API_KEY" } }); const data = await response.json(); ``` ### PHP ```php response = client.send(request, HttpResponse.BodyHandlers.ofString()); ``` ### Ruby ```ruby require "net/http" require "json" uri = URI("https://statsigapi.net/console/v1/autotunes?limit=10&page=1") request = Net::HTTP::Get.new(uri) request["Content-Type"] = "application/json" request["STATSIG-API-KEY"] = "YOUR_API_KEY" response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end ```