Skip to content

Experiments

Experiments in the management API. 16 endpoints.

Read the guideOpenAPI 3.1 document

Try it settings

https://api.bifrostorbit.com/cms/manage/v1

The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

Experiments, up to 200

GET/organisations/{organisationId}/spaces/{spaceId}/experimentsKey required

Experiments, up to 200. contentId, status (active or a status). Permission: experiments:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • contentIdstringquery

    Only experiments on this page.

  • statusstringquery

    active (draft, scheduled, running or paused), or one status.

    One of active, draft, scheduled, running, paused, completed.

Responses

  • 200OKList of experiments.
    • dataExperiment[]

      Up to 200, most recently changed first.

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a4a",      "key": "lofoten-hero",      "name": "Lofoten hero headline",      "hypothesis": null,      "status": "running",      "scope": "blocks",      "targetBlockIds": [        "6650f1c2a9e4b1d2c3f40a5d"      ],      "page": {        "id": "6650f1c2a9e4b1d2c3f40a40",        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "published": true      },      "scopeIds": {        "environmentId": "6650f1c2a9e4b1d2c3f40a13",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18"      },      "variants": [        {          "key": "lofoten-hero",          "name": "Lofoten hero headline",          "control": true,          "weight": 1,          "changed": [            "…"          ],          "edited": false        }      ],      "traffic": 1,      "audience": {        "devices": [          "desktop"        ],        "visitors": "all",        "utm": {          "source": null,          "medium": null,          "campaign": null        },        "countries": [          "…"        ]      },      "goal": {        "key": "lofoten",        "label": "Kayaking",        "goal": {          "kind": "click"        }      },      "guardrails": [        {          "key": "lofoten-hero",          "label": "Kayaking",          "goal": {            "kind": "click"          }        }      ],      "mode": "split",      "startAt": "2026-11-02T09:30:00.000Z",      "endAt": "2026-11-02T09:30:00.000Z",      "minDays": 1,      "startedAt": "2026-11-02T09:30:00.000Z",      "endedAt": "2026-11-02T09:30:00.000Z",      "winner": null,      "holdWinner": false,      "promotedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    }  ]}

Creates one on a page

POST/organisations/{organisationId}/spaces/{spaceId}/experimentsKey required

Creates one on a page. Permission: experiments:manage and content:update.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • contentIdstringrequired

    The page to test.

  • namestringrequired

    Up to 120 characters.
  • hypothesisstring or nulloptional

    Default null. Up to 500 characters.
  • scopestringoptional

    blocks tests chosen blocks, page the whole page.

    One of blocks, page. Default "blocks".
  • targetBlockIdsstring[]optional

    The blocks to test, with scope blocks.

    Default []. Up to 20 items.
  • variantsintegeroptional

    How many variants besides the original, 1 to 3.

    Default 1. At least 1. At most 3.
  • goalobjectrequired

    { label, goal: { kind } }, with kind click, form, engaged, page (with path and match), event (with name) or insights.

    Fields of goal
    • labelstringrequired

      Up to 80 characters.
    • goalobject or object or object or object or object or objectrequired

      Fields of goal

      One of:

      object

      • kind"click"required

      object

      • kind"form"required

      object

      • kind"engaged"required

      object

      • kind"page"required

      • pathstringrequired

        Up to 300 characters.
      • matchstringoptional

        One of exact, prefix. Default "exact".

      object

      • kind"event"required

      • namestringrequired

        Up to 120 characters.

      object

      • kind"insights"required

      • goalIdstringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 120 characters.
      • ruleobject or objectrequired

        Fields of rule

        One of:

        object

        • kind"page"required

        • pathstringrequired

          Up to 300 characters.
        • matchstringrequired

          One of exact, prefix.

        object

        • kind"event"required

        • namestringrequired

          Up to 120 characters.
  • guardrailsobject[]optional

    Up to 3 more goals that must not get worse.

    Default []. Up to 3 items.
    Fields of guardrails
    • labelstringrequired

      Up to 80 characters.
    • goalobject or object or object or object or object or objectrequired

      Fields of goal

      One of:

      object

      • kind"click"required

      object

      • kind"form"required

      object

      • kind"engaged"required

      object

      • kind"page"required

      • pathstringrequired

        Up to 300 characters.
      • matchstringoptional

        One of exact, prefix. Default "exact".

      object

      • kind"event"required

      • namestringrequired

        Up to 120 characters.

      object

      • kind"insights"required

      • goalIdstringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 120 characters.
      • ruleobject or objectrequired

        Fields of rule

        One of:

        object

        • kind"page"required

        • pathstringrequired

          Up to 300 characters.
        • matchstringrequired

          One of exact, prefix.

        object

        • kind"event"required

        • namestringrequired

          Up to 120 characters.
  • audienceobjectoptional

    Default {"devices":[],"visitors":"all","utm":{"source":null,"medium":null,"campaign":null},"countries":[]}.
    Fields of audience
    • devicesstring[]optional

      Default []. Up to 3 items.
    • visitorsstringoptional

      One of all, new, returning. Default "all".
    • utmobjectoptional

      Default {"source":null,"medium":null,"campaign":null}.
      Fields of utm
      • sourcestring or nulloptional

        Default null. Up to 100 characters.
      • mediumstring or nulloptional

        Default null. Up to 100 characters.
      • campaignstring or nulloptional

        Default null. Up to 100 characters.
    • countriesstring[]optional

      Default []. Up to 50 items.
  • trafficintegeroptional

    Per cent of visitors in the experiment.

    Default 100. At least 1. At most 100.
  • modestringoptional

    split shares visitors evenly. bandit sends more to the variant that does best.

    One of split, bandit. Default "split".
  • startAtstring or nulloptional

    Default null.
  • endAtstring or nulloptional

    Default null.
  • minDaysintegeroptional

    Default 7. At least 1. At most 60.

Responses

  • 201CreatedThe new item.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or a page without an address, or no blocks chosen with scope blocks.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage or content:update, or the plan has no experiments.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 409ConflictThe page has an experiment running.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"contentId":"6650f1c2a9e4b1d2c3f40a21","name":"Lofoten hero headline","hypothesis":"Naming the fjords gets more bookings.","targetBlockIds":["hero-1"],"goal":{"label":"Booked a trip","goal":{"kind":"page","path":"/booking/thanks"}}}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

How visitors are assigned: { "assignment": "cookieless" }, consent or cookie

PUT/organisations/{organisationId}/spaces/{spaceId}/experiments/settingsKey required

How visitors are assigned: { "assignment": "cookieless" }, consent or cookie. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • assignmentstringrequired

    cookieless (the default) needs no cookie, consent uses a cookie after the visitor agrees, cookie always uses one.

    One of cookieless, consent, cookie.

Responses

  • 200OK{ assignment }.
    • dataobject

      Fields of data
      • assignmentstring

        One of cookieless, consent, cookie.
  • 400Bad requestThe body isn't valid JSON.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/settings' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"assignment":"consent"}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "assignment": "cookieless"  }}

Deletes one that is not running

DELETE/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}Key required

Deletes one that is not running. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

Responses

  • 204No contentDone, nothing to return.
  • 400Bad requestIt's running. Stop it first.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

One experiment

GET/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}Key required

One experiment. Permission: experiments:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Changes it

PATCH/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}Key required

Changes it. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body, optional

  • namestringoptional

    Up to 120 characters.
  • hypothesisstring or nulloptional

    Up to 500 characters.
  • variantsobject[]optional

    Every variant, with the original: { key, name, weight }. Weights add up to 100. Fixed once it has started.

    Up to 4 items.
    Fields of variants
    • keystringoptional

    • namestringrequired

      Up to 60 characters.
    • weightintegerrequired

      At least 0. At most 100.
  • goalobjectoptional

    Fields of goal
    • labelstringrequired

      Up to 80 characters.
    • goalobject or object or object or object or object or objectrequired

      Fields of goal

      One of:

      object

      • kind"click"required

      object

      • kind"form"required

      object

      • kind"engaged"required

      object

      • kind"page"required

      • pathstringrequired

        Up to 300 characters.
      • matchstringoptional

        One of exact, prefix. Default "exact".

      object

      • kind"event"required

      • namestringrequired

        Up to 120 characters.

      object

      • kind"insights"required

      • goalIdstringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 120 characters.
      • ruleobject or objectrequired

        Fields of rule

        One of:

        object

        • kind"page"required

        • pathstringrequired

          Up to 300 characters.
        • matchstringrequired

          One of exact, prefix.

        object

        • kind"event"required

        • namestringrequired

          Up to 120 characters.
  • guardrailsobject[]optional

    Up to 3 items.
    Fields of guardrails
    • labelstringrequired

      Up to 80 characters.
    • goalobject or object or object or object or object or objectrequired

      Fields of goal

      One of:

      object

      • kind"click"required

      object

      • kind"form"required

      object

      • kind"engaged"required

      object

      • kind"page"required

      • pathstringrequired

        Up to 300 characters.
      • matchstringoptional

        One of exact, prefix. Default "exact".

      object

      • kind"event"required

      • namestringrequired

        Up to 120 characters.

      object

      • kind"insights"required

      • goalIdstringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 120 characters.
      • ruleobject or objectrequired

        Fields of rule

        One of:

        object

        • kind"page"required

        • pathstringrequired

          Up to 300 characters.
        • matchstringrequired

          One of exact, prefix.

        object

        • kind"event"required

        • namestringrequired

          Up to 120 characters.
  • audienceobjectoptional

    Fields of audience
    • devicesstring[]optional

      Default []. Up to 3 items.
    • visitorsstringoptional

      One of all, new, returning. Default "all".
    • utmobjectoptional

      Default {"source":null,"medium":null,"campaign":null}.
      Fields of utm
      • sourcestring or nulloptional

        Default null. Up to 100 characters.
      • mediumstring or nulloptional

        Default null. Up to 100 characters.
      • campaignstring or nulloptional

        Default null. Up to 100 characters.
    • countriesstring[]optional

      Default []. Up to 50 items.
  • trafficintegeroptional

    At least 1. At most 100.
  • modestringoptional

    One of split, bandit.
  • startAtstring or nulloptional

  • endAtstring or nulloptional

  • minDaysintegeroptional

    At least 1. At most 60.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or it has ended, variants, goals or audience change after it started, or weights that don't add up to 100.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Lofoten hero headline","traffic":50}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Pauses it

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/pauseKey required

Pauses it. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or called by an AI agent: a person starts, pauses, resumes and stops experiments.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/pause' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Puts the winning variant in the page's draft: { "variant": "b" }

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/promoteKey required

Puts the winning variant in the page's draft: { "variant": "b" }. Permission: experiments:promote.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • variantstringrequired

    The winning variant's key, a to d. a is the original.

Responses

  • 200OK{ experiment, contentId, requiresApproval, canPublish }.
    • dataobject

      Promoting doesn't publish: publish the page or send it for review afterwards.

      Fields of data
      • experimentExperiment

        Fields of Experiment

      • contentIdstring

        An id.

      • requiresApprovalboolean

        The page needs review before publishing.

      • canPublishboolean

        The token's person may publish it now.

  • 400Bad requestThe body isn't valid JSON. Or it hasn't started, or its winner was already promoted.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:promote, or called by an AI agent.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/promote' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"variant":"b"}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "experiment": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "key": "lofoten",      "name": "Lofoten sea kayaking",      "hypothesis": null,      "status": "draft",      "scope": "blocks",      "targetBlockIds": [        "6650f1c2a9e4b1d2c3f40a5d"      ],      "page": {        "id": "6650f1c2a9e4b1d2c3f40a40",        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "published": true      },      "scopeIds": {        "environmentId": "6650f1c2a9e4b1d2c3f40a13",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18"      },      "variants": [        {          "key": "lofoten",          "name": "Lofoten sea kayaking",          "control": true,          "weight": 1,          "changed": [            "…"          ],          "edited": false        }      ],      "traffic": 1,      "audience": {        "devices": [          "desktop"        ],        "visitors": "all",        "utm": {          "source": null,          "medium": null,          "campaign": null        },        "countries": [          "…"        ]      },      "goal": {        "key": "lofoten",        "label": "Kayaking",        "goal": {          "kind": "click"        }      },      "guardrails": [        {          "key": "lofoten",          "label": "Kayaking",          "goal": {            "kind": "click"          }        }      ],      "mode": "split",      "startAt": "2026-11-02T09:30:00.000Z",      "endAt": "2026-11-02T09:30:00.000Z",      "minDays": 1,      "startedAt": "2026-11-02T09:30:00.000Z",      "endedAt": "2026-11-02T09:30:00.000Z",      "winner": null,      "holdWinner": false,      "promotedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    },    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "requiresApproval": false,    "canPublish": false  }}

Results, with the verdict and each variant

GET/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/resultsKey required

Results, with the verdict and each variant. Permission: experiments:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

Responses

  • 200OKThe results.
    • dataobject

      Fields of data
      • experimentExperiment

        Fields of Experiment

      • daysinteger

      • visitorsPerDaynumber

      • verdictstring

        One of collecting, keepGoing, winner, noDifference, controlWins, mismatch.
      • leaderstring or null

        The variant ahead.

      • daysLeftinteger or null

      • slowboolean

        Too few visitors to finish in good time.

      • guidancestring

        What to do next, in English.

      • guidanceWordingobject

        The guidance as a translation key.

        Fields of guidanceWording
        • keystring

        • valuesmap of any

      • srmobject or null

        Fields of srm
        • pValuenumber

        • mismatchboolean

          Visitors are not split as set, so the results can't be trusted.

      • armsobject[]

        Fields of arms
        • keystring

        • namestring

        • controlboolean

        • visitorsinteger

        • conversionsinteger

        • ratenumber

        • beatControlnumber or null

          The chance it beats the original, 0 to 1.

        • bestnumber

          The chance it's the best, 0 to 1.

        • upliftnumber or null

        • upliftLownumber or null

        • upliftHighnumber or null

        • expectedLossnumber

      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

        • armsobject[]

          Fields of arms
          • keystring

          • namestring

          • ratenumber

          • worsenumber

        • harmedstring[]

      • seriesobject[]

        Running totals by day.

        Fields of series
        • daystring

        • armsmap of object

          Fields of arms
          • visitorsinteger

          • conversionsinteger

          • ratenumber

      • dailyobject[]

        Each day's numbers.

        Fields of daily
        • daystring

        • armsmap of object

          Fields of arms
          • visitorsinteger

          • conversionsinteger

      • neededPerArminteger or null

        Visitors each variant needs.

      • changesmap of any[]

        What each variant changes, by variant key.

      • assignmentstring

        One of cookieless, consent, cookie.
      • insightsany or any or nullsometimes

        With Insights Orbit: reportUrl and a traffic estimate.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/results' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "experiment": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "key": "lofoten",      "name": "Lofoten sea kayaking",      "hypothesis": null,      "status": "draft",      "scope": "blocks",      "targetBlockIds": [        "6650f1c2a9e4b1d2c3f40a5d"      ],      "page": {        "id": "6650f1c2a9e4b1d2c3f40a40",        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "published": true      },      "scopeIds": {        "environmentId": "6650f1c2a9e4b1d2c3f40a13",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18"      },      "variants": [        {          "key": "lofoten",          "name": "Lofoten sea kayaking",          "control": true,          "weight": 1,          "changed": [            "…"          ],          "edited": false        }      ],      "traffic": 1,      "audience": {        "devices": [          "desktop"        ],        "visitors": "all",        "utm": {          "source": null,          "medium": null,          "campaign": null        },        "countries": [          "…"        ]      },      "goal": {        "key": "lofoten",        "label": "Kayaking",        "goal": {          "kind": "click"        }      },      "guardrails": [        {          "key": "lofoten",          "label": "Kayaking",          "goal": {            "kind": "click"          }        }      ],      "mode": "split",      "startAt": "2026-11-02T09:30:00.000Z",      "endAt": "2026-11-02T09:30:00.000Z",      "minDays": 1,      "startedAt": "2026-11-02T09:30:00.000Z",      "endedAt": "2026-11-02T09:30:00.000Z",      "winner": null,      "holdWinner": false,      "promotedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    },    "days": 1,    "visitorsPerDay": 1,    "verdict": "collecting",    "leader": null,    "daysLeft": 1,    "slow": false,    "guidance": "…",    "guidanceWording": {      "key": "lofoten",      "values": {}    },    "srm": {      "pValue": 1,      "mismatch": false    },    "arms": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "control": true,        "visitors": 1,        "conversions": 12,        "rate": 1,        "beatControl": 1,        "best": 1,        "uplift": 1,        "upliftLow": 1,        "upliftHigh": 1,        "expectedLoss": 1      }    ],    "guardrails": [      {        "key": "lofoten",        "label": "Kayaking",        "arms": [          {            "key": "lofoten",            "name": "Lofoten sea kayaking",            "rate": 1,            "worse": 1          }        ],        "harmed": [          "…"        ]      }    ],    "series": [      {        "day": "…",        "arms": {}      }    ],    "daily": [      {        "day": "…",        "arms": {}      }    ],    "neededPerArm": 1,    "changes": {},    "assignment": "cookieless",    "insights": null  }}

Resumes it

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/resumeKey required

Resumes it. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or called by an AI agent: a person starts, pauses, resumes and stops experiments.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/resume' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Starts it, or schedules it when startAt is later

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/startKey required

Starts it, or schedules it when startAt is later. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestIt isn't a draft or scheduled, or isn't ready, such as a variant with no changes.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or called by an AI agent: a person starts, pauses, resumes and stops experiments.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/start' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Ends it

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/stopKey required

Ends it. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or called by an AI agent: a person starts, pauses, resumes and stops experiments.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such experiment, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/stop' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

A variant's content

GET/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/variants/{variantKey}Key required

A variant's content. Permission: experiments:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • variantKeystringpath, required

    The variant's key, a to d. a is the original.

Responses

  • 200OK{ experiment, variant, fields, components, locked }.
    • dataobject

      Fields of data
      • experimentExperiment

        Fields of Experiment

      • variantobject

        Fields of variant
        • keystring

        • namestring

        • controlboolean

      • fieldsmap of any

      • componentsBlock[]

        Fields of Block

      • lockedstring or null

        Why it can't be changed now, such as a running experiment.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such variant, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/variants/b' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "experiment": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "key": "lofoten",      "name": "Lofoten sea kayaking",      "hypothesis": null,      "status": "draft",      "scope": "blocks",      "targetBlockIds": [        "6650f1c2a9e4b1d2c3f40a5d"      ],      "page": {        "id": "6650f1c2a9e4b1d2c3f40a40",        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "published": true      },      "scopeIds": {        "environmentId": "6650f1c2a9e4b1d2c3f40a13",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18"      },      "variants": [        {          "key": "lofoten",          "name": "Lofoten sea kayaking",          "control": true,          "weight": 1,          "changed": [            "…"          ],          "edited": false        }      ],      "traffic": 1,      "audience": {        "devices": [          "desktop"        ],        "visitors": "all",        "utm": {          "source": null,          "medium": null,          "campaign": null        },        "countries": [          "…"        ]      },      "goal": {        "key": "lofoten",        "label": "Kayaking",        "goal": {          "kind": "click"        }      },      "guardrails": [        {          "key": "lofoten",          "label": "Kayaking",          "goal": {            "kind": "click"          }        }      ],      "mode": "split",      "startAt": "2026-11-02T09:30:00.000Z",      "endAt": "2026-11-02T09:30:00.000Z",      "minDays": 1,      "startedAt": "2026-11-02T09:30:00.000Z",      "endedAt": "2026-11-02T09:30:00.000Z",      "winner": null,      "holdWinner": false,      "promotedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    },    "variant": {      "key": "lofoten",      "name": "Lofoten sea kayaking",      "control": true    },    "fields": {},    "components": [      {        "id": "hero-1",        "type": "hero",        "schemaVersion": 12,        "fields": {          "heading": "Paddle the Lofoten fjords"        },        "children": {},        "variant": null      }    ],    "locked": null  }}

Saves a variant's content: { fields, components }

PUT/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/variants/{variantKey}Key required

Saves a variant's content: { fields, components }. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • variantKeystringpath, required

    The variant's key, a to d. a is the original.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body, optional

  • fieldsmap of anyoptional

    The variant's field values.

  • componentsBlock[]optional

    The variant's blocks.

    Fields of components
    • idstringrequired

    • typestringrequired

      The component's key, such as hero.

    • schemaVersionintegerrequired

    • fieldsmap of anyrequired

      The component's fields.

    • childrenmap of Block[]required

      Further blocks by slot.

      Fields of children
      • idstringrequired

      • typestringrequired

        The component's key, such as hero.

      • schemaVersionintegerrequired

      • fieldsmap of anyrequired

        The component's fields.

      • childrenmap of Block[]required

        Further blocks by slot.

        Fields of children
        • idstringrequired

        • typestringrequired

          The component's key, such as hero.

        • schemaVersionintegerrequired

        • fieldsmap of anyrequired

          The component's fields.

        • childrenmap of Block[]required

          Further blocks by slot.

          Fields of children
          • idstringrequired

          • typestringrequired

            The component's key, such as hero.

          • schemaVersionintegerrequired

          • fieldsmap of anyrequired

            The component's fields.

          • childrenmap of Block[]required

            Further blocks by slot.

          • variantstring or nullrequired

        • variantstring or nullrequired

      • variantstring or nullrequired

    • variantstring or nullrequired

Responses

  • 200OK{ savedAt, changed }.
    • dataobject

      Fields of data
      • savedAtstring

      • changedstring[]

        Blocks or fields that now differ from the original.

  • 400Bad requestThe body isn't valid JSON. Or the variant is locked, is the original, changes blocks outside the experiment, or breaks the content type's rules.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such variant, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/variants/b' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"fields":{"title":"Paddle between Reine and Hamnøy"}}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "savedAt": "2026-11-02T09:30:00.000Z",    "changed": [      "…"    ]  }}

Sets a variant back to the page's draft

POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/variants/{variantKey}/resetKey required

Sets a variant back to the page's draft. Permission: experiments:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • experimentIdstringpath, required

    The experiment's id.

  • variantKeystringpath, required

    The variant's key, a to d. a is the original.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 200OKThe experiment.
    • dataExperiment

      Fields of data
      • idstring

        An id.

      • keystring

      • namestring

      • hypothesisstring or null

      • statusstring

        One of draft, scheduled, running, paused, completed.
      • scopestring

        One of blocks, page.
      • targetBlockIdsstring[]

      • pageobject

        Fields of page
        • idstring

          An id.

        • namestring

        • urlstring or null

        • publishedboolean

      • scopeIdsobject

        Fields of scopeIds
        • environmentIdstring

          An id.

        • regionIdstring

          An id.

        • localeIdstring

          An id.

      • variantsobject[]

        Fields of variants
        • keystring

          a is the original, then b, c and d.

        • namestring

        • controlboolean

        • weightinteger

        • changedstring[]

          Blocks or fields that differ from the original.

        • editedboolean

      • trafficinteger

        Per cent of visitors in the experiment.

      • audienceobject

        Fields of audience
        • devicesstring[]

        • visitorsstring

          One of all, new, returning.
        • utmobject

          Fields of utm
          • sourcestring or null

          • mediumstring or null

          • campaignstring or null

        • countriesstring[]

      • goalobject

        Fields of goal
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • guardrailsobject[]

        Fields of guardrails
        • keystring

        • labelstring

          Such as Booked a trip.

        • goalobject

          What counts. page has path and match, event has name, insights has goalId, name and rule.

          Fields of goal
          • kindstring

            One of click, form, engaged, page, event, insights.
      • modestring

        One of split, bandit.
      • startAtstring or null

      • endAtstring or null

      • minDaysinteger

      • startedAtstring or null

      • endedAtstring or null

      • winnerstring or null

      • holdWinnerboolean

      • promotedAtstring or null

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe variant is locked or is the original.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks experiments:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such variant, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/variants/b/reset' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4a",    "key": "lofoten-hero",    "name": "Lofoten hero headline",    "hypothesis": null,    "status": "running",    "scope": "blocks",    "targetBlockIds": [      "6650f1c2a9e4b1d2c3f40a5d"    ],    "page": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "published": true    },    "scopeIds": {      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18"    },    "variants": [      {        "key": "lofoten-hero",        "name": "Lofoten hero headline",        "control": true,        "weight": 1,        "changed": [          "…"        ],        "edited": false      }    ],    "traffic": 1,    "audience": {      "devices": [        "desktop"      ],      "visitors": "all",      "utm": {        "source": null,        "medium": null,        "campaign": null      },      "countries": [        "…"      ]    },    "goal": {      "key": "lofoten",      "label": "Kayaking",      "goal": {        "kind": "click"      }    },    "guardrails": [      {        "key": "lofoten-hero",        "label": "Kayaking",        "goal": {          "kind": "click"        }      }    ],    "mode": "split",    "startAt": "2026-11-02T09:30:00.000Z",    "endAt": "2026-11-02T09:30:00.000Z",    "minDays": 1,    "startedAt": "2026-11-02T09:30:00.000Z",    "endedAt": "2026-11-02T09:30:00.000Z",    "winner": null,    "holdWinner": false,    "promotedAt": "2026-11-02T09:30:00.000Z",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

SchemasThe shapes the endpoints above answer with and take.

Error

Every error has this shape. Write code against code and the status, never the message.

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
    • messagestring

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

      When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Block

One block in a page body.

  • idstring

  • typestring

    The component's key, such as hero.

  • schemaVersioninteger

  • fieldsmap of any

    The component's fields.

  • childrenmap of Block[]

    Further blocks by slot.

    Fields of children
    • idstring

    • typestring

      The component's key, such as hero.

    • schemaVersioninteger

    • fieldsmap of any

      The component's fields.

    • childrenmap of Block[]

      Further blocks by slot.

      Fields of children
      • idstring

      • typestring

        The component's key, such as hero.

      • schemaVersioninteger

      • fieldsmap of any

        The component's fields.

      • childrenmap of Block[]

        Further blocks by slot.

        Fields of children
        • idstring

        • typestring

          The component's key, such as hero.

        • schemaVersioninteger

        • fieldsmap of any

          The component's fields.

        • childrenmap of Block[]

          Further blocks by slot.

        • variantstring or null

      • variantstring or null

    • variantstring or null

  • variantstring or null

Experiment

  • idstring

    An id.

  • keystring

  • namestring

  • hypothesisstring or null

  • statusstring

    One of draft, scheduled, running, paused, completed.
  • scopestring

    One of blocks, page.
  • targetBlockIdsstring[]

  • pageobject

    Fields of page
    • idstring

      An id.

    • namestring

    • urlstring or null

    • publishedboolean

  • scopeIdsobject

    Fields of scopeIds
    • environmentIdstring

      An id.

    • regionIdstring

      An id.

    • localeIdstring

      An id.

  • variantsobject[]

    Fields of variants
    • keystring

      a is the original, then b, c and d.

    • namestring

    • controlboolean

    • weightinteger

    • changedstring[]

      Blocks or fields that differ from the original.

    • editedboolean

  • trafficinteger

    Per cent of visitors in the experiment.

  • audienceobject

    Fields of audience
    • devicesstring[]

    • visitorsstring

      One of all, new, returning.
    • utmobject

      Fields of utm
      • sourcestring or null

      • mediumstring or null

      • campaignstring or null

    • countriesstring[]

  • goalobject

    Fields of goal
    • keystring

    • labelstring

      Such as Booked a trip.

    • goalobject

      What counts. page has path and match, event has name, insights has goalId, name and rule.

      Fields of goal
      • kindstring

        One of click, form, engaged, page, event, insights.
  • guardrailsobject[]

    Fields of guardrails
    • keystring

    • labelstring

      Such as Booked a trip.

    • goalobject

      What counts. page has path and match, event has name, insights has goalId, name and rule.

      Fields of goal
      • kindstring

        One of click, form, engaged, page, event, insights.
  • modestring

    One of split, bandit.
  • startAtstring or null

  • endAtstring or null

  • minDaysinteger

  • startedAtstring or null

  • endedAtstring or null

  • winnerstring or null

  • holdWinnerboolean

  • promotedAtstring or null

  • createdAtstring

  • updatedAtstring