Create A/B experiment

Requires ADMIN. Validates campaign uniqueness (one running experiment per campaign) and that variant weights sum to trafficPercent*100.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

campaignId

string | null

trafficPercent

integer

default: 100 >= 1 <= 100

minSampleSize

integer

default: 1000 >= 1

guardrails

object

key

additional properties

number

variants

required

Array<object>

>= 2 items

object

key

required

string

>= 1 characters <= 60 characters

weight

required

integer

<= 10000

campaignOverrides

object

key

additional properties

any

Responses

201

Created experiment (status=draft).

application/json

object

experiment

object

string

projectId

string

campaignId

string | null

name

string

variantsJson

string

guardrailsJson

string

trafficPercent

integer

minSampleSize

integer

status

string

startedAt

string | null

endedAt

string | null

conclusionJson

string | null

createdAt

string

updatedAt

string

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

409

Campaign already has a running experiment (error=campaign_experiment_conflict).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Zod validation failed (error=‘参数校验失败’ with issues[]).

application/json

object

error

required

string

issues

Array<object>

object

path

string

message

string

details

Array<object>

object

key

additional properties

any

key

additional properties

any

Example

1
{
2
  "error": "参数校验失败"
3
}

POST

/api/projects/{projectId}/experiments

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/experiments \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "campaignId": "<string>",
8
  "trafficPercent": 100,
9
  "minSampleSize": 1000,
10
  "guardrails": {},
11
  "variants": [
12
    {
13
      "key": "<string>",
14
      "weight": 0,
15
      "campaignOverrides": {}
16
    }
17
  ]
18
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/experiments';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","campaignId":"<string>","trafficPercent":100,"minSampleSize":1000,"guardrails":{},"variants":[{"key":"<string>","weight":0,"campaignOverrides":{}}]}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/experiments"
4

5
payload = {
6
    "name": "<string>",
7
    "campaignId": "<string>",
8
    "trafficPercent": 100,
9
    "minSampleSize": 1000,
10
    "guardrails": {},
11
    "variants": [
12
        {
13
            "key": "<string>",
14
            "weight": 0,
15
            "campaignOverrides": {}
16
        }
17
    ]
18
}
19
headers = {
20
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
21
    "Content-Type": "application/json"
22
}
23

24
response = requests.post(url, json=payload, headers=headers)
25

26
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/experiments"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"trafficPercent\": 100,\n  \"minSampleSize\": 1000,\n  \"guardrails\": {},\n  \"variants\": [\n    {\n      \"key\": \"<string>\",\n      \"weight\": 0,\n      \"campaignOverrides\": {}\n    }\n  ]\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/experiments"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"trafficPercent\": 100,\n  \"minSampleSize\": 1000,\n  \"guardrails\": {},\n  \"variants\": [\n    {\n      \"key\": \"<string>\",\n      \"weight\": 0,\n      \"campaignOverrides\": {}\n    }\n  ]\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created experiment (status=draft).

1
{
2
  "experiment": {
3
    "status": "draft"
4
  }
5
}

Create A/B experiment

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

409

Examplegenerated

422

Example

Request Body^required

Example^generated

Example^generated

Example^generated