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

TimeStatusUser Agent

Make a request to see history.

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

namestring

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, running, measuring, concluded or abandoned.

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 what comparable pages did.

effect_pctnumber | nullThat as a percentage of what the changed pages had before.

control_selectionobjectHow the comparison pages were chosen.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.createExperiment('<site_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "name": "string",
    "hypothesis": "string",
    "status": "string",
    "assignment": "string",
    "started_on": "string",
    "ended_on": "string",
    "min_days": 0,
    "verdict": "string",
    "p_value": "string",
    "effect_clicks": "string",
    "effect_pct": "string",
    "control_selection": {}
  }
}