Create a new A/B experiment
curl --request POST \
--url https://api.example.com/api/uat/v1/experiments \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": [
"<string>"
]
},
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>"
}
'import requests
url = "https://api.example.com/api/uat/v1/experiments"
payload = {
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": ["<string>"]
},
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
success_metrics: {primary_metric: '<string>', threshold: 123, p_value: 0.05},
baseline_config: {version: '<string>', filters: {}, scoring: {}, symbols: ['<string>']},
description: '<string>',
hypothesis: '<string>',
created_by: '<string>'
})
};
fetch('https://api.example.com/api/uat/v1/experiments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/uat/v1/experiments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'success_metrics' => [
'primary_metric' => '<string>',
'threshold' => 123,
'p_value' => 0.05
],
'baseline_config' => [
'version' => '<string>',
'filters' => [
],
'scoring' => [
],
'symbols' => [
'<string>'
]
],
'description' => '<string>',
'hypothesis' => '<string>',
'created_by' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/uat/v1/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/uat/v1/experiments")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/uat/v1/experiments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": [
"<string>"
]
},
"experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>",
"status": "draft"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}UAT Testing
Create a new A/B experiment
Create a new experiment with baseline configuration and success metrics.
POST
/
api
/
uat
/
v1
/
experiments
Create a new A/B experiment
curl --request POST \
--url https://api.example.com/api/uat/v1/experiments \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": [
"<string>"
]
},
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>"
}
'import requests
url = "https://api.example.com/api/uat/v1/experiments"
payload = {
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": ["<string>"]
},
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
success_metrics: {primary_metric: '<string>', threshold: 123, p_value: 0.05},
baseline_config: {version: '<string>', filters: {}, scoring: {}, symbols: ['<string>']},
description: '<string>',
hypothesis: '<string>',
created_by: '<string>'
})
};
fetch('https://api.example.com/api/uat/v1/experiments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/uat/v1/experiments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'success_metrics' => [
'primary_metric' => '<string>',
'threshold' => 123,
'p_value' => 0.05
],
'baseline_config' => [
'version' => '<string>',
'filters' => [
],
'scoring' => [
],
'symbols' => [
'<string>'
]
],
'description' => '<string>',
'hypothesis' => '<string>',
'created_by' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/uat/v1/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/uat/v1/experiments")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/uat/v1/experiments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"success_metrics\": {\n \"primary_metric\": \"<string>\",\n \"threshold\": 123,\n \"p_value\": 0.05\n },\n \"baseline_config\": {\n \"version\": \"<string>\",\n \"filters\": {},\n \"scoring\": {},\n \"symbols\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"hypothesis\": \"<string>\",\n \"created_by\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"success_metrics": {
"primary_metric": "<string>",
"threshold": 123,
"p_value": 0.05
},
"baseline_config": {
"version": "<string>",
"filters": {},
"scoring": {},
"symbols": [
"<string>"
]
},
"experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"hypothesis": "<string>",
"created_by": "<string>",
"status": "draft"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Request model for creating a new experiment.
Required string length:
1 - 100Success criteria for an A/B experiment.
Show child attributes
Show child attributes
Configuration snapshot for experiment baseline or variant.
Show child attributes
Show child attributes
What we're testing
Maximum string length:
100Response
Successful Response
Full experiment model with server-generated fields.
Required string length:
1 - 100Success criteria for an A/B experiment.
Show child attributes
Show child attributes
Configuration snapshot for experiment baseline or variant.
Show child attributes
Show child attributes
What we're testing
Maximum string length:
100A/B experiment lifecycle status.
Available options:
draft, active, paused, completed