Skip to content
UltimateTeam.ai Docs

Create an onboarding A/B test

POST
/api/v1/ux/ab-tests

UX-01: Create a new onboarding variant experiment. Rejects variant configs that drop any required compliance step with HTTP 400 COMPLIANCE_VIOLATION.

Authorizations

Request Body required

Request body for POST /api/v1/ux/ab-tests.

object
drop_off_step_id
Any of:
string
hypothesis
required
string
min_observations
integer
default: 100
name
required
string
variant_type
required
string
Allowed values: question_order copy default_selections progress_indicator
variants
required
Array<object>

Runtime config payload for one onboarding variant.

The ordered_step_ids list, when present, is validated by the compliance invariant guard against :data:src.core.compliance.onboarding_invariants.REQUIRED_COMPLIANCE_STEPS.

A variant with no ordered_step_ids inherits the control flow unchanged and is never allowed to hide compliance steps.

object
copy_overrides
object
key
additional properties
string
defaults
object
key
additional properties
any
name
required
string
ordered_step_ids
Array<string>
progress_indicator_style
Any of:
string

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string