STstatsig
Autotunes

Partially Update Autotune

Changed on

Update selected properties of the experiment

patch/console/v1/autotunes/{id}

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/autotunes/{id}
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required

id

Request body

descriptionstring

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

successEventstring

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'

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

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

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%'

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

Whether this is a contextual autotune

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

excludedFeatureListstring[]

Features to exclude from contextual Autotune analysis, even if included in featureList. Omit to leave unchanged on update, or send [] to clear the list.

Response

Partially Update Autotune Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Autotune Experiment updated successfully.",
  "data": {
    "id": "a_autotune",
    "isStarted": false,
    "description": "helpful summary of what this Autotune is",
    "lastModifierID": "jd93DGSnvkauH9FijdGiajh",
    "lastModifierName": "CONSOLE API",
    "inlineTargetingRulesJSON": "{}",
    "inlineTargetingRules": [],
    "variants": [
      {
        "name": "red",
        "json": {
          "color": "red"
        }
      },
      {
        "name": "blue",
        "json": {
          "color": "blue"
        }
      }
    ],
    "successEvent": "purchase_item",
    "successEventValue": "",
    "explorationWindow": "1hr",
    "attributionWindow": "2hrs",
    "winnerThreshold": "99%"
  }
}

Changes

  • 2b9fd791a99aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • 23753feb4120Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response optional property //// became not read-only for the status