Skip to content
UltimateTeam.ai Docs

Create A/B test

POST
/api/v1/gtm/ab-tests

Create a new A/B test.

Authorizations

Request Body required

Request body for creating an A/B test.

object
campaign_id
Any of:
string format: uuid
hypothesis
required
string
>= 1 characters
metric_name
required
string
>= 1 characters <= 100 characters
min_observations
integer
default: 100 >= 10
name
required
string
>= 1 characters <= 255 characters
split_ratio
object
key
additional properties
any
variants
Any of:
Array<object>

Request body for creating a test variant.

object
config
object
key
additional properties
any
name
required
string
>= 1 characters <= 100 characters

Responses

201

Successful Response

Response body for a single A/B test.

object
campaign_id
Any of:
string format: uuid
concluded_at
Any of:
string format: date-time
created_at
required
string format: date-time
hypothesis
required
string
id
required
string format: uuid
metric_name
required
string
min_observations
required
integer
name
required
string
significance_threshold
required
number
split_ratio
required
object
key
additional properties
any
status
required
string
tenant_id
required
string format: uuid
variants
Array<object>

Response body for a single variant.

object
config
required
object
key
additional properties
any
created_at
required
string format: date-time
id
required
string format: uuid
name
required
string
observations
required
integer
successes
required
integer
test_id
required
string format: uuid
winner_variant
Any of:
string

422

Validation Error

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