API overview
A/B Test Design
ab-test-design
Design a rigorous A/B test — hypothesis, metrics, sample size, variants — or an experimentation program.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 900s
- Brand Context
- Optional — pass a brand_context_id
Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.
Input parameters
Pass these under the input object of POST /api/v1/runs.
| Key | Type | Required | Label & description |
|---|---|---|---|
| product_description | short_text | Required | ProductWhat the product is. |
| test_context | long_text | Required | Test idea & observationThe surface, the change idea, and what you observed. |
| test_type | select | Optional | Test typeHow variants are served.Options: A/B (two versions), A/B/n (multiple angles), Multivariate, Split URL |
| baseline_metrics | short_text | Optional | Current numbersYour own conversion rate and volume. |
| traffic_context | short_text | Optional | Weekly trafficEligible traffic per week. |
| experiment_program | select | Optional | ScopeOne test or a program.Options: Single test, Experimentation program |
| interaction_language | select | Optional | Report languageControls the language of the generated report.Options: English, Chinese |
Request example
Covers every required field. Optional fields follow the same pattern.
curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
-H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"app_slug": "ab-test-design",
"input": {
"product_description": "example text",
"test_context": "example text"
}
}'What you get back
A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).