SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Set up a change to measure

Creating one does not start it. Call POST /experiments/{experiment_id}/pages with the pages you are changing, which picks comparable pages for you and starts the clock.

POSThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/experiments

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Body Params

namestringrequired

What to call it.

hypothesisstring | null

What you expect to happen.

min_daysinteger | null

The shortest window to report on, never below 21.

Response

Response Body

idstringThe experiment id.
namestringWhat you called it.
hypothesisstring | nullWhat you expected to happen.
statusstringdraft (no pages yet), running, measuring (measured at least once, no verdict yet), concluded, or abandoned (stopped from the dashboard).
assignmentstringmatched or random.
started_onstring | nullWhen the pages were enrolled.
ended_onstring | nullWhen it concluded.
min_daysintegerThe shortest window that will be reported on.
verdictstring | nullwin, loss, flat or inconclusive. Null until measured.
p_valuenumber | nullHow likely a gap this large is by chance. Null when inconclusive.
effect_clicksnumber | nullExtra clicks per changed page over the whole run, beyond what comparable pages did. The before and after windows cover the same number of days.
effect_pctnumber | nullThat as a percentage of what the changed pages had before.
control_selectionobjectHow the comparison pages were chosen.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/experiments \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Rewrite the pricing page",
"hypothesis": "A clearer heading will earn more clicks.",
"min_days": 28
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
"data": {
"id": "7c2b0f10-0000-4000-8000-000000000000",
"name": "Rewrite the pricing page",
"hypothesis": "A clearer heading will earn more clicks.",
"status": "running",
"assignment": "matched",
"started_on": "2026-08-01",
"ended_on": null,
"min_days": 21,
"verdict": null,
"p_value": 0.04,
"effect_clicks": 42.5,
"effect_pct": 18.2,
"control_selection": {}
}
}