Sign in
Experiments
Experiments

Partially Update Experiment

patch/console/v1/experiments/{id}

Path parameters

idstring required

id

Request body

namestring

The display name of the experiment

descriptionstring

A helpful summary of what this experiment does

idTypestring

The type of ID which the experiment is based on

secondaryIDTypestring nullable

The secondary ID type for the experiment used in WHN for ID resolution

identifierMappingMode'strictOneToOne' | 'firstTouchOneToMany' | 'lastTouchOneToMany'

The identifier mapping mode for the experiment used in WHN for ID resolution

identityResolutionSourcestring nullable

The identity resolution entity property source for the experiment used in WHN for ID resolution

hypothesisstring

A statement that will be tested by this experiment

controlGroupIDstring

Optional control group ID

allocationnumber double

Percent of layer allocated to this experiment

userBucketsnumber[]
primaryMetricTagsstring[]

Primary metric tags for the experiment

secondaryMetricTagsstring[]

Secondary metric tags for the experiment

tagsstring[]

Tags associated with the experiment

durationinteger

How long the experiment is expected to last in days

targetExposuresinteger

Target exposures for the experiment

targetingGateIDstring nullable

Restrict your experiment to users passing the selected feature gate

sequentialTestingboolean

Apply sequential testing?

bonferroniCorrectionboolean

Is Bonferroni correction applied per variant?

bonferroniCorrectionPerMetricboolean

Is Bonferroni correction applied per metric?

benjaminiHochbergPerVariantboolean

Is Benjamini-Hochberg procedure applied per variant?

benjaminiHochbergPerMetricboolean

Is Benjamini-Hochberg procedure applied per metric?

benjaminiPrimaryMetricsOnlyboolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

defaultConfidenceInterval'80' | '90' | '95' | '98' | '99'

Default error margin used for results

defaultRollupWindowinteger

Default rollup window in days for experiment results. Use -1 for cumulative. Only -1, 1, and 7 allowed for cloud experiments.

defaultChanceToBeatThresholdnumber double

Default chance-to-beat threshold used for Bayesian results.

status'active' | 'setup' | 'decision_made' | 'abandoned' | 'archived' | 'experiment_stopped' | 'assignment_stopped'

The current status of the experiment

launchedGroupIDstring nullable

ID of the launched group, null otherwise

assignmentSourceNamestring

Source name of the assignment

assignmentSourceExperimentNamestring

Name of the source experiment for assignment

creatorIDstring nullable

The Statsig ID of the creator of this experiment

creatorEmailstring nullable

The email of the creator of this experiment

isAnalysisOnlyboolean nullable

For Warehouse Native

teamstring nullable

The team name associated with the experiment, Enterprise only.

teamIDstring nullable

The team ID associated with the experiment, Enterprise only.

allocationDurationinteger nullable

Warehouse Native Only - Allocation duration in days

cohortedAnalysisDurationinteger

Warehouse Native Only - Cohorted analysis duration in days

cohortedMetricsMatureAfterEndboolean

Warehouse Native Only - Allow cohort metrics to mature after experiment end

cohortWaitUntilEndToIncludeboolean

Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists

fixedAnalysisDurationinteger

Fixed analysis duration in days

scheduledReloadHourinteger nullable

Warehouse Native only - UTC hour at which to run scheduled pulse loads

scheduledReloadType'full' | 'incremental'

Warehouse Native only - reload type for scheduled reloads

scheduledReloadDaysinteger[] nullable

Warehouse Native only - days on which to run scheduled reloads from 0 to 6, 0 meaning Sunday. Null to run reloads on all days.

turboModeboolean

Warehouse Native only - whether to run scheduled reloads with Turbo mode.

autoLoadToplineImpactboolean

Warehouse Native only - whether to automatically run topline and projected launch impact calculations when reloading experiments.

analysisEndTimestring

Warehouse Native only - end time for analysis only experiments

analyticsType'frequentist' | 'bayesian' | 'sprt'

The mode of analysis for the experiment, e.g frequentist, bayesian, sprt

defaultSPRTPowerParamnumber double

SPRT power parameter percentage used as the default for experiment analysis.

defaultSPRTMDEnumber double

Default MDE value for every metric if one isn't provided. Only used in manual mode.

sprtBaselineMode'manual' | 'in_experiment_control'

In manual mode, mde/mean/stdDev must be provided for every metric in the experiment. In in_experiment_control, only the mde is needed for every metric, or the defaultSPRTMDE field must be passed.

isSidecarboolean

Whether this is a Statsig Sidecar experiment. sidecarEditorURL, sidecarURLFilters, sidecarDisableAutoRun, and sidecarPrerunScript are saved only when this is true.

sidecarEditorURLstring

Sidecar (Visual Editor) only: the URL of the page being modified. The Visual Editor cannot open without it, and it must be an http or https URL.

sidecarDisableAutoRunboolean

Sidecar (Visual Editor) only: whether to disable auto-running the experiment on page load. By default the experiment auto runs.

sidecarPrerunScriptstring nullable

Sidecar (Visual Editor) only: a script to run before the experiment starts. Send null to clear it.

decisionReasonstring

Experiment notes reported after experiment completes

enabledNonProdEnvironmentsstring[]

Response

Partially Update Experiment Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "string",
  "data": {
    "id": "a_experiment",
    "description": "a helpful summary of what this experiment does",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "f0JAV9dd7KF0sUbi1DHWB",
    "idType": "userID",
    "status": "setup",
    "layerID": "layer1",
    "hypothesis": "Does 1 or 0 work better?",
    "primaryMetrics": [
      {
        "name": "l14",
        "type": "user"
      }
    ],
    "primaryMetricTags": [],
    "secondaryMetrics": [
      {
        "name": "mau_28d",
        "type": "user"
      }
    ],
    "secondaryMetricTags": [],
    "groups": [
      {
        "name": "group1",
        "size": 50,
        "parameterValues": {
          "key": 1
        }
      },
      {
        "name": "gruop2",
        "size": 50,
        "parameterValues": {
          "key": 0
        }
      }
    ],
    "allocation": 50.46,
    "duration": 14,
    "targetingGateID": "a_gate",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "tags": []
  }
}

Changes

Changed in 3 of the 8 revisions of this API.2622

  • 1fd471fa03cc26See the full diff
    • ●

      added the new after enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new any_case_sensitive enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_all enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new before enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new encoded_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new is_not_null enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new is_null enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new lt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new lte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new none_case_sensitive enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new not_array_contains_all enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new on enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_contains_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_contains_none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_matches enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_eq enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_gt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_gte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_lt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_lte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

  • 439e60273a2e11See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/allowOverridesInPulse to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/bonferroniPrimaryMetricWeight to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/defaultImpactMultiplier to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/defaultSPRTControlDelta to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/defaultSPRTTestDelta to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/excludePausedExposuresAndEvents to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/isHistoricalCloudExperiment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/isImpactBankEnabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/originalScheduledReloadHour to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/originalTargetExposures to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/reviewsRequiredLocally to the response with the 200 status

      response-optional-property-added

  • 3189f450c93b11See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/groups/items/foreignGroupIDVerified to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/groups/items/images to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/groups/items/isControl to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/groups/items/shipped to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/isPromptExperiment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/isTemplate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/originalTargetDuration to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/restartReason to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/salt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/scheduledStartTime to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/wasAutoDisabled to the response with the 200 status

      response-optional-property-added