statsig.Experiment
Explore with Pulumi AI
This resource allows you to configure experiments for your Statsig project.
To learn more about experiments, see Experiments Documentation
To learn more about the API powering this resource, see Experiments API Documentation
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
simple:
type: statsig:Experiment
properties:
allocation: 10
description: A short description of what this Experiment is used for.
groups:
- name: Test
parameter_values:
- aString: test
size: 50
- name: Control
parameter_values:
- aString: control
size: 50
idType: userID
Create Experiment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Experiment(name: string, args?: ExperimentArgs, opts?: CustomResourceOptions);
@overload
def Experiment(resource_name: str,
args: Optional[ExperimentArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Experiment(resource_name: str,
opts: Optional[ResourceOptions] = None,
allocation: Optional[float] = None,
allocation_duration: Optional[int] = None,
analysis_end_time: Optional[str] = None,
analytics_type: Optional[str] = None,
assignment_source_experiment_name: Optional[str] = None,
assignment_source_name: Optional[str] = None,
benjamini_hochberg_per_metric: Optional[bool] = None,
benjamini_hochberg_per_variant: Optional[bool] = None,
benjamini_primary_metrics_only: Optional[bool] = None,
bonferroni_correction: Optional[bool] = None,
bonferroni_correction_per_metric: Optional[bool] = None,
cohort_wait_until_end_to_include: Optional[bool] = None,
cohorted_analysis_duration: Optional[int] = None,
cohorted_metrics_mature_after_end: Optional[bool] = None,
control_group_id: Optional[str] = None,
creator_email: Optional[str] = None,
creator_id: Optional[str] = None,
default_confidence_interval: Optional[str] = None,
description: Optional[str] = None,
duration: Optional[int] = None,
fixed_analysis_duration: Optional[int] = None,
groups: Optional[Sequence[ExperimentGroupArgs]] = None,
hypothesis: Optional[str] = None,
id_type: Optional[str] = None,
is_analysis_only: Optional[bool] = None,
launched_group_id: Optional[str] = None,
layer_id: Optional[str] = None,
links: Optional[Sequence[ExperimentLinkArgs]] = None,
name: Optional[str] = None,
primary_metric_tags: Optional[Sequence[str]] = None,
primary_metrics: Optional[Sequence[ExperimentPrimaryMetricArgs]] = None,
scheduled_reload_hour: Optional[int] = None,
scheduled_reload_type: Optional[str] = None,
secondary_idtype: Optional[str] = None,
secondary_metric_tags: Optional[Sequence[str]] = None,
secondary_metrics: Optional[Sequence[ExperimentSecondaryMetricArgs]] = None,
sequential_testing: Optional[bool] = None,
status: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
target_apps: Optional[Sequence[str]] = None,
target_exposures: Optional[int] = None,
targeting_gate_id: Optional[str] = None,
team: Optional[str] = None)
func NewExperiment(ctx *Context, name string, args *ExperimentArgs, opts ...ResourceOption) (*Experiment, error)
public Experiment(string name, ExperimentArgs? args = null, CustomResourceOptions? opts = null)
public Experiment(String name, ExperimentArgs args)
public Experiment(String name, ExperimentArgs args, CustomResourceOptions options)
type: statsig:Experiment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var experimentResource = new Pulumi.Experiment("experimentResource", new()
{
Allocation = 0,
AllocationDuration = 0,
AnalysisEndTime = "string",
AnalyticsType = "string",
AssignmentSourceExperimentName = "string",
AssignmentSourceName = "string",
BenjaminiHochbergPerMetric = false,
BenjaminiHochbergPerVariant = false,
BenjaminiPrimaryMetricsOnly = false,
BonferroniCorrection = false,
BonferroniCorrectionPerMetric = false,
CohortWaitUntilEndToInclude = false,
CohortedAnalysisDuration = 0,
CohortedMetricsMatureAfterEnd = false,
ControlGroupId = "string",
CreatorEmail = "string",
CreatorId = "string",
DefaultConfidenceInterval = "string",
Description = "string",
Duration = 0,
FixedAnalysisDuration = 0,
Groups = new[]
{
new Pulumi.Inputs.ExperimentGroupArgs
{
Name = "string",
ParameterValues =
{
{ "string", "string" },
},
Size = 0,
Description = "string",
Disabled = false,
ForeignGroupId = "string",
Id = "string",
},
},
Hypothesis = "string",
IdType = "string",
IsAnalysisOnly = false,
LaunchedGroupId = "string",
LayerId = "string",
Links = new[]
{
new Pulumi.Inputs.ExperimentLinkArgs
{
Url = "string",
Title = "string",
},
},
Name = "string",
PrimaryMetricTags = new[]
{
"string",
},
PrimaryMetrics = new[]
{
new Pulumi.Inputs.ExperimentPrimaryMetricArgs
{
Direction = "string",
HypothesizedValue = 0,
Name = "string",
Type = "string",
},
},
ScheduledReloadHour = 0,
ScheduledReloadType = "string",
SecondaryIdtype = "string",
SecondaryMetricTags = new[]
{
"string",
},
SecondaryMetrics = new[]
{
new Pulumi.Inputs.ExperimentSecondaryMetricArgs
{
Direction = "string",
HypothesizedValue = 0,
Name = "string",
Type = "string",
},
},
SequentialTesting = false,
Status = "string",
Tags = new[]
{
"string",
},
TargetApps = new[]
{
"string",
},
TargetExposures = 0,
TargetingGateId = "string",
Team = "string",
});
example, err := statsig.NewExperiment(ctx, "experimentResource", &statsig.ExperimentArgs{
Allocation: pulumi.Float64(0),
AllocationDuration: pulumi.Int(0),
AnalysisEndTime: pulumi.String("string"),
AnalyticsType: pulumi.String("string"),
AssignmentSourceExperimentName: pulumi.String("string"),
AssignmentSourceName: pulumi.String("string"),
BenjaminiHochbergPerMetric: pulumi.Bool(false),
BenjaminiHochbergPerVariant: pulumi.Bool(false),
BenjaminiPrimaryMetricsOnly: pulumi.Bool(false),
BonferroniCorrection: pulumi.Bool(false),
BonferroniCorrectionPerMetric: pulumi.Bool(false),
CohortWaitUntilEndToInclude: pulumi.Bool(false),
CohortedAnalysisDuration: pulumi.Int(0),
CohortedMetricsMatureAfterEnd: pulumi.Bool(false),
ControlGroupId: pulumi.String("string"),
CreatorEmail: pulumi.String("string"),
CreatorId: pulumi.String("string"),
DefaultConfidenceInterval: pulumi.String("string"),
Description: pulumi.String("string"),
Duration: pulumi.Int(0),
FixedAnalysisDuration: pulumi.Int(0),
Groups: statsig.ExperimentGroupArray{
&statsig.ExperimentGroupArgs{
Name: pulumi.String("string"),
ParameterValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
Size: pulumi.Float64(0),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
ForeignGroupId: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
Hypothesis: pulumi.String("string"),
IdType: pulumi.String("string"),
IsAnalysisOnly: pulumi.Bool(false),
LaunchedGroupId: pulumi.String("string"),
LayerId: pulumi.String("string"),
Links: statsig.ExperimentLinkArray{
&statsig.ExperimentLinkArgs{
Url: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
PrimaryMetricTags: pulumi.StringArray{
pulumi.String("string"),
},
PrimaryMetrics: statsig.ExperimentPrimaryMetricArray{
&statsig.ExperimentPrimaryMetricArgs{
Direction: pulumi.String("string"),
HypothesizedValue: pulumi.Float64(0),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
ScheduledReloadHour: pulumi.Int(0),
ScheduledReloadType: pulumi.String("string"),
SecondaryIdtype: pulumi.String("string"),
SecondaryMetricTags: pulumi.StringArray{
pulumi.String("string"),
},
SecondaryMetrics: statsig.ExperimentSecondaryMetricArray{
&statsig.ExperimentSecondaryMetricArgs{
Direction: pulumi.String("string"),
HypothesizedValue: pulumi.Float64(0),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
SequentialTesting: pulumi.Bool(false),
Status: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TargetApps: pulumi.StringArray{
pulumi.String("string"),
},
TargetExposures: pulumi.Int(0),
TargetingGateId: pulumi.String("string"),
Team: pulumi.String("string"),
})
var experimentResource = new Experiment("experimentResource", ExperimentArgs.builder()
.allocation(0.0)
.allocationDuration(0)
.analysisEndTime("string")
.analyticsType("string")
.assignmentSourceExperimentName("string")
.assignmentSourceName("string")
.benjaminiHochbergPerMetric(false)
.benjaminiHochbergPerVariant(false)
.benjaminiPrimaryMetricsOnly(false)
.bonferroniCorrection(false)
.bonferroniCorrectionPerMetric(false)
.cohortWaitUntilEndToInclude(false)
.cohortedAnalysisDuration(0)
.cohortedMetricsMatureAfterEnd(false)
.controlGroupId("string")
.creatorEmail("string")
.creatorId("string")
.defaultConfidenceInterval("string")
.description("string")
.duration(0)
.fixedAnalysisDuration(0)
.groups(ExperimentGroupArgs.builder()
.name("string")
.parameterValues(Map.of("string", "string"))
.size(0.0)
.description("string")
.disabled(false)
.foreignGroupId("string")
.id("string")
.build())
.hypothesis("string")
.idType("string")
.isAnalysisOnly(false)
.launchedGroupId("string")
.layerId("string")
.links(ExperimentLinkArgs.builder()
.url("string")
.title("string")
.build())
.name("string")
.primaryMetricTags("string")
.primaryMetrics(ExperimentPrimaryMetricArgs.builder()
.direction("string")
.hypothesizedValue(0.0)
.name("string")
.type("string")
.build())
.scheduledReloadHour(0)
.scheduledReloadType("string")
.secondaryIdtype("string")
.secondaryMetricTags("string")
.secondaryMetrics(ExperimentSecondaryMetricArgs.builder()
.direction("string")
.hypothesizedValue(0.0)
.name("string")
.type("string")
.build())
.sequentialTesting(false)
.status("string")
.tags("string")
.targetApps("string")
.targetExposures(0)
.targetingGateId("string")
.team("string")
.build());
experiment_resource = statsig.Experiment("experimentResource",
allocation=0,
allocation_duration=0,
analysis_end_time="string",
analytics_type="string",
assignment_source_experiment_name="string",
assignment_source_name="string",
benjamini_hochberg_per_metric=False,
benjamini_hochberg_per_variant=False,
benjamini_primary_metrics_only=False,
bonferroni_correction=False,
bonferroni_correction_per_metric=False,
cohort_wait_until_end_to_include=False,
cohorted_analysis_duration=0,
cohorted_metrics_mature_after_end=False,
control_group_id="string",
creator_email="string",
creator_id="string",
default_confidence_interval="string",
description="string",
duration=0,
fixed_analysis_duration=0,
groups=[{
"name": "string",
"parameter_values": {
"string": "string",
},
"size": 0,
"description": "string",
"disabled": False,
"foreign_group_id": "string",
"id": "string",
}],
hypothesis="string",
id_type="string",
is_analysis_only=False,
launched_group_id="string",
layer_id="string",
links=[{
"url": "string",
"title": "string",
}],
name="string",
primary_metric_tags=["string"],
primary_metrics=[{
"direction": "string",
"hypothesized_value": 0,
"name": "string",
"type": "string",
}],
scheduled_reload_hour=0,
scheduled_reload_type="string",
secondary_idtype="string",
secondary_metric_tags=["string"],
secondary_metrics=[{
"direction": "string",
"hypothesized_value": 0,
"name": "string",
"type": "string",
}],
sequential_testing=False,
status="string",
tags=["string"],
target_apps=["string"],
target_exposures=0,
targeting_gate_id="string",
team="string")
const experimentResource = new statsig.Experiment("experimentResource", {
allocation: 0,
allocationDuration: 0,
analysisEndTime: "string",
analyticsType: "string",
assignmentSourceExperimentName: "string",
assignmentSourceName: "string",
benjaminiHochbergPerMetric: false,
benjaminiHochbergPerVariant: false,
benjaminiPrimaryMetricsOnly: false,
bonferroniCorrection: false,
bonferroniCorrectionPerMetric: false,
cohortWaitUntilEndToInclude: false,
cohortedAnalysisDuration: 0,
cohortedMetricsMatureAfterEnd: false,
controlGroupId: "string",
creatorEmail: "string",
creatorId: "string",
defaultConfidenceInterval: "string",
description: "string",
duration: 0,
fixedAnalysisDuration: 0,
groups: [{
name: "string",
parameterValues: {
string: "string",
},
size: 0,
description: "string",
disabled: false,
foreignGroupId: "string",
id: "string",
}],
hypothesis: "string",
idType: "string",
isAnalysisOnly: false,
launchedGroupId: "string",
layerId: "string",
links: [{
url: "string",
title: "string",
}],
name: "string",
primaryMetricTags: ["string"],
primaryMetrics: [{
direction: "string",
hypothesizedValue: 0,
name: "string",
type: "string",
}],
scheduledReloadHour: 0,
scheduledReloadType: "string",
secondaryIdtype: "string",
secondaryMetricTags: ["string"],
secondaryMetrics: [{
direction: "string",
hypothesizedValue: 0,
name: "string",
type: "string",
}],
sequentialTesting: false,
status: "string",
tags: ["string"],
targetApps: ["string"],
targetExposures: 0,
targetingGateId: "string",
team: "string",
});
type: statsig:Experiment
properties:
allocation: 0
allocationDuration: 0
analysisEndTime: string
analyticsType: string
assignmentSourceExperimentName: string
assignmentSourceName: string
benjaminiHochbergPerMetric: false
benjaminiHochbergPerVariant: false
benjaminiPrimaryMetricsOnly: false
bonferroniCorrection: false
bonferroniCorrectionPerMetric: false
cohortWaitUntilEndToInclude: false
cohortedAnalysisDuration: 0
cohortedMetricsMatureAfterEnd: false
controlGroupId: string
creatorEmail: string
creatorId: string
defaultConfidenceInterval: string
description: string
duration: 0
fixedAnalysisDuration: 0
groups:
- description: string
disabled: false
foreignGroupId: string
id: string
name: string
parameterValues:
string: string
size: 0
hypothesis: string
idType: string
isAnalysisOnly: false
launchedGroupId: string
layerId: string
links:
- title: string
url: string
name: string
primaryMetricTags:
- string
primaryMetrics:
- direction: string
hypothesizedValue: 0
name: string
type: string
scheduledReloadHour: 0
scheduledReloadType: string
secondaryIdtype: string
secondaryMetricTags:
- string
secondaryMetrics:
- direction: string
hypothesizedValue: 0
name: string
type: string
sequentialTesting: false
status: string
tags:
- string
targetApps:
- string
targetExposures: 0
targetingGateId: string
team: string
Experiment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Experiment resource accepts the following input properties:
- Allocation double
- Percent of layer allocated to this experiment
- Allocation
Duration int - Warehouse Native Only - Allocation duration in days
- Analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- Analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- Assignment
Source stringExperiment Name - Name of the source experiment for assignment
- Assignment
Source stringName - Source name of the assignment
- Benjamini
Hochberg boolPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- Benjamini
Hochberg boolPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- Benjamini
Primary boolMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- Bonferroni
Correction bool - Is Bonferroni correction applied per variant?
- Bonferroni
Correction boolPer Metric - Is Bonferroni correction applied per metric?
- Cohort
Wait boolUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- Cohorted
Analysis intDuration - Warehouse Native Only - Cohorted analysis duration in days
- Cohorted
Metrics boolMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- Control
Group stringId - Optional control group ID
- Creator
Email string - The email of the creator of this experiment
- Creator
Id string - The Statsig ID of the creator of this experiment
- Default
Confidence stringInterval - Default error margin used for results
- Description string
- A description of the new experiment
- Duration int
- How long the experiment is expected to last in days
- Fixed
Analysis intDuration - Fixed analysis duration in days
- Groups
List<Statsig.
Pulumi. Inputs. Experiment Group> - The test groups for your experiment
- Hypothesis string
- A statement that will be tested by this experiment
- Id
Type string - The idType the experiment will be performed on
- Is
Analysis boolOnly - For Warehouse Native
- Launched
Group stringId - ID of the launched group, null otherwise
- Layer
Id string - Which layer to place the experiment into.
- Links
List<Statsig.
Pulumi. Inputs. Experiment Link> - Links to relevant documentation or resources
- Name string
- The name of the new experiment
- List<string>
- Primary metric tags for the experiment
- Primary
Metrics List<Statsig.Pulumi. Inputs. Experiment Primary Metric> - Main metrics needed to evaluate your hypothesis
- Scheduled
Reload intHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- Scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- Secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- List<string>
- Secondary metric tags for the experiment
- Secondary
Metrics List<Statsig.Pulumi. Inputs. Experiment Secondary Metric> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- Sequential
Testing bool - Apply sequential testing?
- Status string
- The current status of the experiment
- List<string>
- Tags associated with the experiment
- Target
Apps List<string> - Target apps assigned to this experiment
- Target
Exposures int - Target exposures for the experiment
- Targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- Team string
- Enterprise only
- Allocation float64
- Percent of layer allocated to this experiment
- Allocation
Duration int - Warehouse Native Only - Allocation duration in days
- Analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- Analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- Assignment
Source stringExperiment Name - Name of the source experiment for assignment
- Assignment
Source stringName - Source name of the assignment
- Benjamini
Hochberg boolPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- Benjamini
Hochberg boolPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- Benjamini
Primary boolMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- Bonferroni
Correction bool - Is Bonferroni correction applied per variant?
- Bonferroni
Correction boolPer Metric - Is Bonferroni correction applied per metric?
- Cohort
Wait boolUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- Cohorted
Analysis intDuration - Warehouse Native Only - Cohorted analysis duration in days
- Cohorted
Metrics boolMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- Control
Group stringId - Optional control group ID
- Creator
Email string - The email of the creator of this experiment
- Creator
Id string - The Statsig ID of the creator of this experiment
- Default
Confidence stringInterval - Default error margin used for results
- Description string
- A description of the new experiment
- Duration int
- How long the experiment is expected to last in days
- Fixed
Analysis intDuration - Fixed analysis duration in days
- Groups
[]Experiment
Group Args - The test groups for your experiment
- Hypothesis string
- A statement that will be tested by this experiment
- Id
Type string - The idType the experiment will be performed on
- Is
Analysis boolOnly - For Warehouse Native
- Launched
Group stringId - ID of the launched group, null otherwise
- Layer
Id string - Which layer to place the experiment into.
- Links
[]Experiment
Link Args - Links to relevant documentation or resources
- Name string
- The name of the new experiment
- []string
- Primary metric tags for the experiment
- Primary
Metrics []ExperimentPrimary Metric Args - Main metrics needed to evaluate your hypothesis
- Scheduled
Reload intHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- Scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- Secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- []string
- Secondary metric tags for the experiment
- Secondary
Metrics []ExperimentSecondary Metric Args - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- Sequential
Testing bool - Apply sequential testing?
- Status string
- The current status of the experiment
- []string
- Tags associated with the experiment
- Target
Apps []string - Target apps assigned to this experiment
- Target
Exposures int - Target exposures for the experiment
- Targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- Team string
- Enterprise only
- allocation Double
- Percent of layer allocated to this experiment
- allocation
Duration Integer - Warehouse Native Only - Allocation duration in days
- analysis
End StringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type String - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source StringExperiment Name - Name of the source experiment for assignment
- assignment
Source StringName - Source name of the assignment
- benjamini
Hochberg BooleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg BooleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary BooleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction Boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction BooleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait BooleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis IntegerDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics BooleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group StringId - Optional control group ID
- creator
Email String - The email of the creator of this experiment
- creator
Id String - The Statsig ID of the creator of this experiment
- default
Confidence StringInterval - Default error margin used for results
- description String
- A description of the new experiment
- duration Integer
- How long the experiment is expected to last in days
- fixed
Analysis IntegerDuration - Fixed analysis duration in days
- groups
List<Experiment
Group> - The test groups for your experiment
- hypothesis String
- A statement that will be tested by this experiment
- id
Type String - The idType the experiment will be performed on
- is
Analysis BooleanOnly - For Warehouse Native
- launched
Group StringId - ID of the launched group, null otherwise
- layer
Id String - Which layer to place the experiment into.
- links
List<Experiment
Link> - Links to relevant documentation or resources
- name String
- The name of the new experiment
- List<String>
- Primary metric tags for the experiment
- primary
Metrics List<ExperimentPrimary Metric> - Main metrics needed to evaluate your hypothesis
- scheduled
Reload IntegerHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload StringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype String - The secondary ID type for the experiment used in WHN for ID resolution
- List<String>
- Secondary metric tags for the experiment
- secondary
Metrics List<ExperimentSecondary Metric> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing Boolean - Apply sequential testing?
- status String
- The current status of the experiment
- List<String>
- Tags associated with the experiment
- target
Apps List<String> - Target apps assigned to this experiment
- target
Exposures Integer - Target exposures for the experiment
- targeting
Gate StringId - Restrict your experiment to users passing the selected feature gate
- team String
- Enterprise only
- allocation number
- Percent of layer allocated to this experiment
- allocation
Duration number - Warehouse Native Only - Allocation duration in days
- analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source stringExperiment Name - Name of the source experiment for assignment
- assignment
Source stringName - Source name of the assignment
- benjamini
Hochberg booleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg booleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary booleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction booleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait booleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis numberDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics booleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group stringId - Optional control group ID
- creator
Email string - The email of the creator of this experiment
- creator
Id string - The Statsig ID of the creator of this experiment
- default
Confidence stringInterval - Default error margin used for results
- description string
- A description of the new experiment
- duration number
- How long the experiment is expected to last in days
- fixed
Analysis numberDuration - Fixed analysis duration in days
- groups
Experiment
Group[] - The test groups for your experiment
- hypothesis string
- A statement that will be tested by this experiment
- id
Type string - The idType the experiment will be performed on
- is
Analysis booleanOnly - For Warehouse Native
- launched
Group stringId - ID of the launched group, null otherwise
- layer
Id string - Which layer to place the experiment into.
- links
Experiment
Link[] - Links to relevant documentation or resources
- name string
- The name of the new experiment
- string[]
- Primary metric tags for the experiment
- primary
Metrics ExperimentPrimary Metric[] - Main metrics needed to evaluate your hypothesis
- scheduled
Reload numberHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- string[]
- Secondary metric tags for the experiment
- secondary
Metrics ExperimentSecondary Metric[] - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing boolean - Apply sequential testing?
- status string
- The current status of the experiment
- string[]
- Tags associated with the experiment
- target
Apps string[] - Target apps assigned to this experiment
- target
Exposures number - Target exposures for the experiment
- targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- team string
- Enterprise only
- allocation float
- Percent of layer allocated to this experiment
- allocation_
duration int - Warehouse Native Only - Allocation duration in days
- analysis_
end_ strtime - Warehouse Native only - end time for analysis only experiments
- analytics_
type str - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment_
source_ strexperiment_ name - Name of the source experiment for assignment
- assignment_
source_ strname - Source name of the assignment
- benjamini_
hochberg_ boolper_ metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini_
hochberg_ boolper_ variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini_
primary_ boolmetrics_ only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni_
correction bool - Is Bonferroni correction applied per variant?
- bonferroni_
correction_ boolper_ metric - Is Bonferroni correction applied per metric?
- cohort_
wait_ booluntil_ end_ to_ include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted_
analysis_ intduration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted_
metrics_ boolmature_ after_ end - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control_
group_ strid - Optional control group ID
- creator_
email str - The email of the creator of this experiment
- creator_
id str - The Statsig ID of the creator of this experiment
- default_
confidence_ strinterval - Default error margin used for results
- description str
- A description of the new experiment
- duration int
- How long the experiment is expected to last in days
- fixed_
analysis_ intduration - Fixed analysis duration in days
- groups
Sequence[Experiment
Group Args] - The test groups for your experiment
- hypothesis str
- A statement that will be tested by this experiment
- id_
type str - The idType the experiment will be performed on
- is_
analysis_ boolonly - For Warehouse Native
- launched_
group_ strid - ID of the launched group, null otherwise
- layer_
id str - Which layer to place the experiment into.
- links
Sequence[Experiment
Link Args] - Links to relevant documentation or resources
- name str
- The name of the new experiment
- Sequence[str]
- Primary metric tags for the experiment
- primary_
metrics Sequence[ExperimentPrimary Metric Args] - Main metrics needed to evaluate your hypothesis
- scheduled_
reload_ inthour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled_
reload_ strtype - Warehouse Native only - reload type for scheduled reloads
- secondary_
idtype str - The secondary ID type for the experiment used in WHN for ID resolution
- Sequence[str]
- Secondary metric tags for the experiment
- secondary_
metrics Sequence[ExperimentSecondary Metric Args] - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential_
testing bool - Apply sequential testing?
- status str
- The current status of the experiment
- Sequence[str]
- Tags associated with the experiment
- target_
apps Sequence[str] - Target apps assigned to this experiment
- target_
exposures int - Target exposures for the experiment
- targeting_
gate_ strid - Restrict your experiment to users passing the selected feature gate
- team str
- Enterprise only
- allocation Number
- Percent of layer allocated to this experiment
- allocation
Duration Number - Warehouse Native Only - Allocation duration in days
- analysis
End StringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type String - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source StringExperiment Name - Name of the source experiment for assignment
- assignment
Source StringName - Source name of the assignment
- benjamini
Hochberg BooleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg BooleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary BooleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction Boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction BooleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait BooleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis NumberDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics BooleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group StringId - Optional control group ID
- creator
Email String - The email of the creator of this experiment
- creator
Id String - The Statsig ID of the creator of this experiment
- default
Confidence StringInterval - Default error margin used for results
- description String
- A description of the new experiment
- duration Number
- How long the experiment is expected to last in days
- fixed
Analysis NumberDuration - Fixed analysis duration in days
- groups List<Property Map>
- The test groups for your experiment
- hypothesis String
- A statement that will be tested by this experiment
- id
Type String - The idType the experiment will be performed on
- is
Analysis BooleanOnly - For Warehouse Native
- launched
Group StringId - ID of the launched group, null otherwise
- layer
Id String - Which layer to place the experiment into.
- links List<Property Map>
- Links to relevant documentation or resources
- name String
- The name of the new experiment
- List<String>
- Primary metric tags for the experiment
- primary
Metrics List<Property Map> - Main metrics needed to evaluate your hypothesis
- scheduled
Reload NumberHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload StringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype String - The secondary ID type for the experiment used in WHN for ID resolution
- List<String>
- Secondary metric tags for the experiment
- secondary
Metrics List<Property Map> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing Boolean - Apply sequential testing?
- status String
- The current status of the experiment
- List<String>
- Tags associated with the experiment
- target
Apps List<String> - Target apps assigned to this experiment
- target
Exposures Number - Target exposures for the experiment
- targeting
Gate StringId - Restrict your experiment to users passing the selected feature gate
- team String
- Enterprise only
Outputs
All input properties are implicitly available as output properties. Additionally, the Experiment resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Experiment Resource
Get an existing Experiment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ExperimentState, opts?: CustomResourceOptions): Experiment
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allocation: Optional[float] = None,
allocation_duration: Optional[int] = None,
analysis_end_time: Optional[str] = None,
analytics_type: Optional[str] = None,
assignment_source_experiment_name: Optional[str] = None,
assignment_source_name: Optional[str] = None,
benjamini_hochberg_per_metric: Optional[bool] = None,
benjamini_hochberg_per_variant: Optional[bool] = None,
benjamini_primary_metrics_only: Optional[bool] = None,
bonferroni_correction: Optional[bool] = None,
bonferroni_correction_per_metric: Optional[bool] = None,
cohort_wait_until_end_to_include: Optional[bool] = None,
cohorted_analysis_duration: Optional[int] = None,
cohorted_metrics_mature_after_end: Optional[bool] = None,
control_group_id: Optional[str] = None,
creator_email: Optional[str] = None,
creator_id: Optional[str] = None,
default_confidence_interval: Optional[str] = None,
description: Optional[str] = None,
duration: Optional[int] = None,
fixed_analysis_duration: Optional[int] = None,
groups: Optional[Sequence[ExperimentGroupArgs]] = None,
hypothesis: Optional[str] = None,
id_type: Optional[str] = None,
is_analysis_only: Optional[bool] = None,
launched_group_id: Optional[str] = None,
layer_id: Optional[str] = None,
links: Optional[Sequence[ExperimentLinkArgs]] = None,
name: Optional[str] = None,
primary_metric_tags: Optional[Sequence[str]] = None,
primary_metrics: Optional[Sequence[ExperimentPrimaryMetricArgs]] = None,
scheduled_reload_hour: Optional[int] = None,
scheduled_reload_type: Optional[str] = None,
secondary_idtype: Optional[str] = None,
secondary_metric_tags: Optional[Sequence[str]] = None,
secondary_metrics: Optional[Sequence[ExperimentSecondaryMetricArgs]] = None,
sequential_testing: Optional[bool] = None,
status: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
target_apps: Optional[Sequence[str]] = None,
target_exposures: Optional[int] = None,
targeting_gate_id: Optional[str] = None,
team: Optional[str] = None) -> Experiment
func GetExperiment(ctx *Context, name string, id IDInput, state *ExperimentState, opts ...ResourceOption) (*Experiment, error)
public static Experiment Get(string name, Input<string> id, ExperimentState? state, CustomResourceOptions? opts = null)
public static Experiment get(String name, Output<String> id, ExperimentState state, CustomResourceOptions options)
resources: _: type: statsig:Experiment get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allocation double
- Percent of layer allocated to this experiment
- Allocation
Duration int - Warehouse Native Only - Allocation duration in days
- Analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- Analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- Assignment
Source stringExperiment Name - Name of the source experiment for assignment
- Assignment
Source stringName - Source name of the assignment
- Benjamini
Hochberg boolPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- Benjamini
Hochberg boolPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- Benjamini
Primary boolMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- Bonferroni
Correction bool - Is Bonferroni correction applied per variant?
- Bonferroni
Correction boolPer Metric - Is Bonferroni correction applied per metric?
- Cohort
Wait boolUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- Cohorted
Analysis intDuration - Warehouse Native Only - Cohorted analysis duration in days
- Cohorted
Metrics boolMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- Control
Group stringId - Optional control group ID
- Creator
Email string - The email of the creator of this experiment
- Creator
Id string - The Statsig ID of the creator of this experiment
- Default
Confidence stringInterval - Default error margin used for results
- Description string
- A description of the new experiment
- Duration int
- How long the experiment is expected to last in days
- Fixed
Analysis intDuration - Fixed analysis duration in days
- Groups
List<Statsig.
Pulumi. Inputs. Experiment Group> - The test groups for your experiment
- Hypothesis string
- A statement that will be tested by this experiment
- Id
Type string - The idType the experiment will be performed on
- Is
Analysis boolOnly - For Warehouse Native
- Launched
Group stringId - ID of the launched group, null otherwise
- Layer
Id string - Which layer to place the experiment into.
- Links
List<Statsig.
Pulumi. Inputs. Experiment Link> - Links to relevant documentation or resources
- Name string
- The name of the new experiment
- List<string>
- Primary metric tags for the experiment
- Primary
Metrics List<Statsig.Pulumi. Inputs. Experiment Primary Metric> - Main metrics needed to evaluate your hypothesis
- Scheduled
Reload intHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- Scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- Secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- List<string>
- Secondary metric tags for the experiment
- Secondary
Metrics List<Statsig.Pulumi. Inputs. Experiment Secondary Metric> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- Sequential
Testing bool - Apply sequential testing?
- Status string
- The current status of the experiment
- List<string>
- Tags associated with the experiment
- Target
Apps List<string> - Target apps assigned to this experiment
- Target
Exposures int - Target exposures for the experiment
- Targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- Team string
- Enterprise only
- Allocation float64
- Percent of layer allocated to this experiment
- Allocation
Duration int - Warehouse Native Only - Allocation duration in days
- Analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- Analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- Assignment
Source stringExperiment Name - Name of the source experiment for assignment
- Assignment
Source stringName - Source name of the assignment
- Benjamini
Hochberg boolPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- Benjamini
Hochberg boolPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- Benjamini
Primary boolMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- Bonferroni
Correction bool - Is Bonferroni correction applied per variant?
- Bonferroni
Correction boolPer Metric - Is Bonferroni correction applied per metric?
- Cohort
Wait boolUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- Cohorted
Analysis intDuration - Warehouse Native Only - Cohorted analysis duration in days
- Cohorted
Metrics boolMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- Control
Group stringId - Optional control group ID
- Creator
Email string - The email of the creator of this experiment
- Creator
Id string - The Statsig ID of the creator of this experiment
- Default
Confidence stringInterval - Default error margin used for results
- Description string
- A description of the new experiment
- Duration int
- How long the experiment is expected to last in days
- Fixed
Analysis intDuration - Fixed analysis duration in days
- Groups
[]Experiment
Group Args - The test groups for your experiment
- Hypothesis string
- A statement that will be tested by this experiment
- Id
Type string - The idType the experiment will be performed on
- Is
Analysis boolOnly - For Warehouse Native
- Launched
Group stringId - ID of the launched group, null otherwise
- Layer
Id string - Which layer to place the experiment into.
- Links
[]Experiment
Link Args - Links to relevant documentation or resources
- Name string
- The name of the new experiment
- []string
- Primary metric tags for the experiment
- Primary
Metrics []ExperimentPrimary Metric Args - Main metrics needed to evaluate your hypothesis
- Scheduled
Reload intHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- Scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- Secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- []string
- Secondary metric tags for the experiment
- Secondary
Metrics []ExperimentSecondary Metric Args - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- Sequential
Testing bool - Apply sequential testing?
- Status string
- The current status of the experiment
- []string
- Tags associated with the experiment
- Target
Apps []string - Target apps assigned to this experiment
- Target
Exposures int - Target exposures for the experiment
- Targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- Team string
- Enterprise only
- allocation Double
- Percent of layer allocated to this experiment
- allocation
Duration Integer - Warehouse Native Only - Allocation duration in days
- analysis
End StringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type String - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source StringExperiment Name - Name of the source experiment for assignment
- assignment
Source StringName - Source name of the assignment
- benjamini
Hochberg BooleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg BooleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary BooleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction Boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction BooleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait BooleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis IntegerDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics BooleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group StringId - Optional control group ID
- creator
Email String - The email of the creator of this experiment
- creator
Id String - The Statsig ID of the creator of this experiment
- default
Confidence StringInterval - Default error margin used for results
- description String
- A description of the new experiment
- duration Integer
- How long the experiment is expected to last in days
- fixed
Analysis IntegerDuration - Fixed analysis duration in days
- groups
List<Experiment
Group> - The test groups for your experiment
- hypothesis String
- A statement that will be tested by this experiment
- id
Type String - The idType the experiment will be performed on
- is
Analysis BooleanOnly - For Warehouse Native
- launched
Group StringId - ID of the launched group, null otherwise
- layer
Id String - Which layer to place the experiment into.
- links
List<Experiment
Link> - Links to relevant documentation or resources
- name String
- The name of the new experiment
- List<String>
- Primary metric tags for the experiment
- primary
Metrics List<ExperimentPrimary Metric> - Main metrics needed to evaluate your hypothesis
- scheduled
Reload IntegerHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload StringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype String - The secondary ID type for the experiment used in WHN for ID resolution
- List<String>
- Secondary metric tags for the experiment
- secondary
Metrics List<ExperimentSecondary Metric> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing Boolean - Apply sequential testing?
- status String
- The current status of the experiment
- List<String>
- Tags associated with the experiment
- target
Apps List<String> - Target apps assigned to this experiment
- target
Exposures Integer - Target exposures for the experiment
- targeting
Gate StringId - Restrict your experiment to users passing the selected feature gate
- team String
- Enterprise only
- allocation number
- Percent of layer allocated to this experiment
- allocation
Duration number - Warehouse Native Only - Allocation duration in days
- analysis
End stringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type string - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source stringExperiment Name - Name of the source experiment for assignment
- assignment
Source stringName - Source name of the assignment
- benjamini
Hochberg booleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg booleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary booleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction booleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait booleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis numberDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics booleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group stringId - Optional control group ID
- creator
Email string - The email of the creator of this experiment
- creator
Id string - The Statsig ID of the creator of this experiment
- default
Confidence stringInterval - Default error margin used for results
- description string
- A description of the new experiment
- duration number
- How long the experiment is expected to last in days
- fixed
Analysis numberDuration - Fixed analysis duration in days
- groups
Experiment
Group[] - The test groups for your experiment
- hypothesis string
- A statement that will be tested by this experiment
- id
Type string - The idType the experiment will be performed on
- is
Analysis booleanOnly - For Warehouse Native
- launched
Group stringId - ID of the launched group, null otherwise
- layer
Id string - Which layer to place the experiment into.
- links
Experiment
Link[] - Links to relevant documentation or resources
- name string
- The name of the new experiment
- string[]
- Primary metric tags for the experiment
- primary
Metrics ExperimentPrimary Metric[] - Main metrics needed to evaluate your hypothesis
- scheduled
Reload numberHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload stringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype string - The secondary ID type for the experiment used in WHN for ID resolution
- string[]
- Secondary metric tags for the experiment
- secondary
Metrics ExperimentSecondary Metric[] - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing boolean - Apply sequential testing?
- status string
- The current status of the experiment
- string[]
- Tags associated with the experiment
- target
Apps string[] - Target apps assigned to this experiment
- target
Exposures number - Target exposures for the experiment
- targeting
Gate stringId - Restrict your experiment to users passing the selected feature gate
- team string
- Enterprise only
- allocation float
- Percent of layer allocated to this experiment
- allocation_
duration int - Warehouse Native Only - Allocation duration in days
- analysis_
end_ strtime - Warehouse Native only - end time for analysis only experiments
- analytics_
type str - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment_
source_ strexperiment_ name - Name of the source experiment for assignment
- assignment_
source_ strname - Source name of the assignment
- benjamini_
hochberg_ boolper_ metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini_
hochberg_ boolper_ variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini_
primary_ boolmetrics_ only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni_
correction bool - Is Bonferroni correction applied per variant?
- bonferroni_
correction_ boolper_ metric - Is Bonferroni correction applied per metric?
- cohort_
wait_ booluntil_ end_ to_ include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted_
analysis_ intduration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted_
metrics_ boolmature_ after_ end - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control_
group_ strid - Optional control group ID
- creator_
email str - The email of the creator of this experiment
- creator_
id str - The Statsig ID of the creator of this experiment
- default_
confidence_ strinterval - Default error margin used for results
- description str
- A description of the new experiment
- duration int
- How long the experiment is expected to last in days
- fixed_
analysis_ intduration - Fixed analysis duration in days
- groups
Sequence[Experiment
Group Args] - The test groups for your experiment
- hypothesis str
- A statement that will be tested by this experiment
- id_
type str - The idType the experiment will be performed on
- is_
analysis_ boolonly - For Warehouse Native
- launched_
group_ strid - ID of the launched group, null otherwise
- layer_
id str - Which layer to place the experiment into.
- links
Sequence[Experiment
Link Args] - Links to relevant documentation or resources
- name str
- The name of the new experiment
- Sequence[str]
- Primary metric tags for the experiment
- primary_
metrics Sequence[ExperimentPrimary Metric Args] - Main metrics needed to evaluate your hypothesis
- scheduled_
reload_ inthour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled_
reload_ strtype - Warehouse Native only - reload type for scheduled reloads
- secondary_
idtype str - The secondary ID type for the experiment used in WHN for ID resolution
- Sequence[str]
- Secondary metric tags for the experiment
- secondary_
metrics Sequence[ExperimentSecondary Metric Args] - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential_
testing bool - Apply sequential testing?
- status str
- The current status of the experiment
- Sequence[str]
- Tags associated with the experiment
- target_
apps Sequence[str] - Target apps assigned to this experiment
- target_
exposures int - Target exposures for the experiment
- targeting_
gate_ strid - Restrict your experiment to users passing the selected feature gate
- team str
- Enterprise only
- allocation Number
- Percent of layer allocated to this experiment
- allocation
Duration Number - Warehouse Native Only - Allocation duration in days
- analysis
End StringTime - Warehouse Native only - end time for analysis only experiments
- analytics
Type String - The mode of analysis for the experiment, e.g frequentist, bayesian, sprt
- assignment
Source StringExperiment Name - Name of the source experiment for assignment
- assignment
Source StringName - Source name of the assignment
- benjamini
Hochberg BooleanPer Metric - Is Benjamini-Hochberg procedure applied per metric?
- benjamini
Hochberg BooleanPer Variant - Is Benjamini-Hochberg procedure applied per variant?
- benjamini
Primary BooleanMetrics Only - Is Benjamini-Hochberg procedure applied for primary metrics only?
- bonferroni
Correction Boolean - Is Bonferroni correction applied per variant?
- bonferroni
Correction BooleanPer Metric - Is Bonferroni correction applied per metric?
- cohort
Wait BooleanUntil End To Include - Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
- cohorted
Analysis NumberDuration - Warehouse Native Only - Cohorted analysis duration in days
- cohorted
Metrics BooleanMature After End - Warehouse Native Only - Allow cohort metrics to mature after experiment end
- control
Group StringId - Optional control group ID
- creator
Email String - The email of the creator of this experiment
- creator
Id String - The Statsig ID of the creator of this experiment
- default
Confidence StringInterval - Default error margin used for results
- description String
- A description of the new experiment
- duration Number
- How long the experiment is expected to last in days
- fixed
Analysis NumberDuration - Fixed analysis duration in days
- groups List<Property Map>
- The test groups for your experiment
- hypothesis String
- A statement that will be tested by this experiment
- id
Type String - The idType the experiment will be performed on
- is
Analysis BooleanOnly - For Warehouse Native
- launched
Group StringId - ID of the launched group, null otherwise
- layer
Id String - Which layer to place the experiment into.
- links List<Property Map>
- Links to relevant documentation or resources
- name String
- The name of the new experiment
- List<String>
- Primary metric tags for the experiment
- primary
Metrics List<Property Map> - Main metrics needed to evaluate your hypothesis
- scheduled
Reload NumberHour - Warehouse Native only - UTC hour at which to run scheduled pulse loads
- scheduled
Reload StringType - Warehouse Native only - reload type for scheduled reloads
- secondary
Idtype String - The secondary ID type for the experiment used in WHN for ID resolution
- List<String>
- Secondary metric tags for the experiment
- secondary
Metrics List<Property Map> - Additional metrics to monitor that might impact the analysis or final decision of the experiment
- sequential
Testing Boolean - Apply sequential testing?
- status String
- The current status of the experiment
- List<String>
- Tags associated with the experiment
- target
Apps List<String> - Target apps assigned to this experiment
- target
Exposures Number - Target exposures for the experiment
- targeting
Gate StringId - Restrict your experiment to users passing the selected feature gate
- team String
- Enterprise only
Supporting Types
ExperimentGroup, ExperimentGroupArgs
- Name string
- Parameter
Values Dictionary<string, string> - Size double
- Description string
- Disabled bool
- Foreign
Group stringId - Id string
- Name string
- Parameter
Values map[string]string - Size float64
- Description string
- Disabled bool
- Foreign
Group stringId - Id string
- name String
- parameter
Values Map<String,String> - size Double
- description String
- disabled Boolean
- foreign
Group StringId - id String
- name string
- parameter
Values {[key: string]: string} - size number
- description string
- disabled boolean
- foreign
Group stringId - id string
- name str
- parameter_
values Mapping[str, str] - size float
- description str
- disabled bool
- foreign_
group_ strid - id str
- name String
- parameter
Values Map<String> - size Number
- description String
- disabled Boolean
- foreign
Group StringId - id String
ExperimentLink, ExperimentLinkArgs
ExperimentPrimaryMetric, ExperimentPrimaryMetricArgs
- Direction string
- Hypothesized
Value double - Name string
- Type string
- Direction string
- Hypothesized
Value float64 - Name string
- Type string
- direction String
- hypothesized
Value Double - name String
- type String
- direction string
- hypothesized
Value number - name string
- type string
- direction str
- hypothesized_
value float - name str
- type str
- direction String
- hypothesized
Value Number - name String
- type String
ExperimentSecondaryMetric, ExperimentSecondaryMetricArgs
- Direction string
- Hypothesized
Value double - Name string
- Type string
- Direction string
- Hypothesized
Value float64 - Name string
- Type string
- direction String
- hypothesized
Value Double - name String
- type String
- direction string
- hypothesized
Value number - name string
- type string
- direction str
- hypothesized_
value float - name str
- type str
- direction String
- hypothesized
Value Number - name String
- type String
Package Details
- Repository
- statsig statsig-io/pulumi-statsig
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
statsig
Terraform Provider.