Experiments

Update experiment analysis plan attributes

Update selected statistical analysis settings. Omitted attributes remain unchanged and nullable attributes can be cleared with null. Protocol-locked settings cannot be changed.

patch/api/v2/experiments/{experiment_id}/analysis-plan

Request

Path parameters

experiment_idstring uuid required

The UUID of the experiment.

Example:550e8400-e29b-41d4-a716-446655440000

Request body

Example request

{
  "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,
      "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"
  }
}

Response

OK

Example response

{
  "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"
  },
  "meta": {
    "warnings": [
      {
        "code": "code",
        "detail": "detail"
      }
    ]
  }
}

Changes

Changes to this operation have not been checked yet.