ab-tests

Preview A/B test plan

Calculate the sample targets and analysis boundaries for a confidence-mode test without creating it.

Required permission: ab_tests.create.

post/v1/projects/{project_id}/ab-tests/plan-preview

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/ab-tests/plan-preview
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment the test would run in.

Request body

traffic_percentageinteger required

Percentage of traffic routed to the variant, 1 to 99.

Response

Successful Response

planned_control_samplesinteger required

Maximum control sample, including the sequential design's inflation and a minimum of 80 per arm.

planned_variant_samplesinteger required

Maximum variant sample, including the sequential design's inflation and a minimum of 80 per arm.

total_samplesinteger required

Sum of the planned control and variant samples.

fixed_horizon_control_samplesinteger required

Control sample a single analysis at the end would need.

fixed_horizon_variant_samplesinteger required

Variant sample a single analysis at the end would need.

max_information_inflationnumber required

Factor by which the sequential design increases the fixed-horizon sample.

look_fractionsnumber[] required

Shares of the planned sample at which analysis looks happen.

Changes

No recorded changes to this operation across all 2 revisions of this API.