GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/analysis-plan https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan
Overview Get the effective public statistical analysis settings for an experiment. has_custom_analysis_settings compares only settings the caller can edit; protocol-required differences from company defaults do not make the plan custom.
This endpoint requires the product_analytics_experiments_read permission.
OAuth apps require the product_analytics_experiments_read authorization scope to access this endpoint.
Arguments Path Parameters The UUID of the experiment.
Response OK
Response containing the analysis settings for an experiment.
Expand All
Analysis plan resource with its identifier and settings.
Statistical settings and duration targets in the saved analysis plan.
Parameters of the prior distribution used for Bayesian analysis.
Degrees of freedom of the prior distribution.
Standard deviation of the prior distribution.
confidence_interval_method
Statistical method used to calculate the experiment results.
Allowed enum values: Sequential,FixedSample,Bayesian,SequentialFixedHybrid
Confidence level used for statistical analysis, expressed as a fraction.
cuped_lookback_period_days
Number of days of pre-experiment data used for CUPED variance reduction.
Number of days configured for the experiment to end automatically.
Minimum experiment duration in days configured in the analysis plan.
experiment_min_sample_size
Minimum sample size configured in the analysis plan.
has_custom_analysis_settings
Whether the experiment has custom analysis settings.
Whether CUPED uses pre-experiment data to reduce variance in the analysis.
is_multiple_testing_correction_enabled
Whether the analysis adjusts for testing multiple hypotheses.
preferential_bonferroni_primary_metric_weight
Weight assigned to the primary metric in the preferential Bonferroni correction.
Planned experiment duration in days.
Identifier of the experiment whose analysis plan is returned.
Analysis plans resource type.
Allowed enum values: analysis-plans
default: analysis-plans
{
"data" : {
"attributes" : {
"bayesian_prior" : {
"degrees_of_freedom" : null ,
"standard_deviation" : 0.05
},
"confidence_interval_method" : "Bayesian" ,
"confidence_level" : 0.95 ,
"cuped_lookback_period_days" : 30 ,
"experiment_auto_end_days" : 0 ,
"experiment_min_duration" : 0 ,
"experiment_min_sample_size" : 0 ,
"has_custom_analysis_settings" : false ,
"is_cuped_enabled" : true ,
"is_multiple_testing_correction_enabled" : false ,
"preferential_bonferroni_primary_metric_weight" : 0.5 ,
"target_duration_days" : 14
},
"id" : "550e8400-e29b-41d4-a716-446655440000" ,
"type" : "analysis-plans"
}
} Malformed experiment ID.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Forbidden
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Not Found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export experiment_id = "550e8400-e29b-41d4-a716-446655440000" # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN = "<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" # Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/experiments/${experiment_id}/analysis-plan " \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN} " 
