STstatsig
Experiments
Experiments

Create Experiment

Changed on
post/console/v1/experiments

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/experiments
  • Auth
    API key in header STATSIG-API-KEY

Request body

namestring required

The experiment display name

descriptionstring

A description of the new experiment

idTypestring

The idType the experiment will be performed 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

Expected length of the experiment in days. Create and update accept duration or targetExposures, not both. On update, sending duration clears a stored targetExposures. Omit the field to keep the stored value. null is not accepted.

targetExposuresinteger

Exposure count that ends the experiment. On update, sending targetExposures clears a stored duration. Omit the field to keep the stored value. null is not accepted.

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[]
idstring

The experiment name ID

layerIDstring

Which layer to place the experiment into.

isTemplateboolean

Whether this experiment is a template that other experiments can be created from. Settable at creation only.

Example request

{
  "name": "Test Experiment",
  "description": "Description test",
  "inlineTargetingRules": [
    {
      "name": "Eligible users",
      "passPercentage": 100,
      "conditions": [
        {
          "type": "passes_segment",
          "targetValue": "paid_users"
        }
      ]
    }
  ]
}

Response

Create Experiment Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Experiment created successfully.",
  "data": {
    "id": "a_experiment",
    "permalink": "https://console.statsig.com/company_id/experiments/a_experiment",
    "name": "a_experiment",
    "description": "description",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifiedTime": 1707427635442,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
    "createdTime": 1707427634717,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "holdoutIDs": [],
    "tags": [],
    "status": "setup",
    "experimentType": "BASE",
    "launchedGroupID": null,
    "startTime": null,
    "endTime": null,
    "layerID": null,
    "hypothesis": "This will be a good feature :)",
    "primaryMetrics": [
      {
        "name": "d1_retention_rate",
        "type": "user"
      }
    ],
    "primaryMetricTags": [],
    "secondaryMetrics": [],
    "secondaryMetricTags": [],
    "groups": [
      {
        "name": "Control",
        "id": "6sEQvUd4c6E55V6ljBYMeJ",
        "size": 50,
        "parameterValues": {
          "assigned_group": "control"
        },
        "description": "",
        "isControl": true
      },
      {
        "name": "Test",
        "id": "6sEQvVS6EoNzpkEgUJUpxL",
        "size": 50,
        "parameterValues": {
          "assigned_group": "test"
        },
        "description": "",
        "isControl": false
      }
    ],
    "allocation": 100,
    "duration": 14,
    "targetingGateID": "",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "decisionReason": null,
    "decisionTime": null,
    "healthChecks": [],
    "healthCheckStatus": "PASSED",
    "isStale": false,
    "inlineTargetingRulesJSON": "{}",
    "powerAnalyses": []
  }
}

Changes

  • 605b784f2a7dRevision 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

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

  • a7f43412fb6bRevision changes
    • info

      added the new optional request property

    • info

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

    • info

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