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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
contentIdstringqueryOnly experiments on this page.
statusstringqueryactive (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
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
contentIdstringrequiredThe page to test.
Up to 120 characters.namestringrequired
Default null. Up to 500 characters.hypothesisstring or nulloptionalscopestringoptionalblocks tests chosen blocks, page the whole page.
One of blocks, page. Default "blocks".targetBlockIdsstring[]optionalThe blocks to test, with scope blocks.
Default []. Up to 20 items.variantsintegeroptionalHow 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
Up to 80 characters.labelstringrequiredgoalobject or object or object or object or object or objectrequiredFields of goal
One of:
object
kind"click"required
object
kind"form"required
object
kind"engaged"required
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix. Default "exact".matchstringoptional
object
kind"event"required
Up to 120 characters.namestringrequired
object
kind"insights"required
Up to 64 characters.goalIdstringrequired
Up to 120 characters.namestringrequiredruleobject or objectrequiredFields of rule
One of:
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix.matchstringrequired
object
kind"event"required
Up to 120 characters.namestringrequired
guardrailsobject[]optionalUp to 3 more goals that must not get worse.
Default []. Up to 3 items.Fields of guardrails
Up to 80 characters.labelstringrequiredgoalobject or object or object or object or object or objectrequiredFields of goal
One of:
object
kind"click"required
object
kind"form"required
object
kind"engaged"required
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix. Default "exact".matchstringoptional
object
kind"event"required
Up to 120 characters.namestringrequired
object
kind"insights"required
Up to 64 characters.goalIdstringrequired
Up to 120 characters.namestringrequiredruleobject or objectrequiredFields of rule
One of:
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix.matchstringrequired
object
kind"event"required
Up to 120 characters.namestringrequired
Default {"devices":[],"visitors":"all","utm":{"source":null,"medium":null,"campaign":null},"countries":[]}.audienceobjectoptionalFields of audience
Default []. Up to 3 items.devicesstring[]optional
One of all, new, returning. Default "all".visitorsstringoptional
Default {"source":null,"medium":null,"campaign":null}.utmobjectoptionalFields of utm
Default null. Up to 100 characters.sourcestring or nulloptional
Default null. Up to 100 characters.mediumstring or nulloptional
Default null. Up to 100 characters.campaignstring or nulloptional
Default []. Up to 50 items.countriesstring[]optional
trafficintegeroptionalPer cent of visitors in the experiment.
Default 100. At least 1. At most 100.modestringoptionalsplit shares visitors evenly. bandit sends more to the variant that does best.
One of split, bandit. Default "split".
Default null.startAtstring or nulloptional
Default null.endAtstring or nulloptional
Default 7. At least 1. At most 60.minDaysintegeroptional
Responses
201CreatedThe new item.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or a page without an address, or no blocks chosen with scope blocks.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
assignmentstringrequiredcookieless (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 }.dataobjectFields of data
One of cookieless, consent, cookie.assignmentstring
400Bad requestThe body isn't valid JSON.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Responses
204No contentDone, nothing to return.400Bad requestIt's running. Stop it first.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Responses
200OKThe experiment.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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
Up to 120 characters.namestringoptional
Up to 500 characters.hypothesisstring or nulloptionalvariantsobject[]optionalEvery 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
Up to 60 characters.namestringrequired
At least 0. At most 100.weightintegerrequired
goalobjectoptionalFields of goal
Up to 80 characters.labelstringrequiredgoalobject or object or object or object or object or objectrequiredFields of goal
One of:
object
kind"click"required
object
kind"form"required
object
kind"engaged"required
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix. Default "exact".matchstringoptional
object
kind"event"required
Up to 120 characters.namestringrequired
object
kind"insights"required
Up to 64 characters.goalIdstringrequired
Up to 120 characters.namestringrequiredruleobject or objectrequiredFields of rule
One of:
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix.matchstringrequired
object
kind"event"required
Up to 120 characters.namestringrequired
Up to 3 items.guardrailsobject[]optionalFields of guardrails
Up to 80 characters.labelstringrequiredgoalobject or object or object or object or object or objectrequiredFields of goal
One of:
object
kind"click"required
object
kind"form"required
object
kind"engaged"required
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix. Default "exact".matchstringoptional
object
kind"event"required
Up to 120 characters.namestringrequired
object
kind"insights"required
Up to 64 characters.goalIdstringrequired
Up to 120 characters.namestringrequiredruleobject or objectrequiredFields of rule
One of:
object
kind"page"required
Up to 300 characters.pathstringrequired
One of exact, prefix.matchstringrequired
object
kind"event"required
Up to 120 characters.namestringrequired
audienceobjectoptionalFields of audience
Default []. Up to 3 items.devicesstring[]optional
One of all, new, returning. Default "all".visitorsstringoptional
Default {"source":null,"medium":null,"campaign":null}.utmobjectoptionalFields of utm
Default null. Up to 100 characters.sourcestring or nulloptional
Default null. Up to 100 characters.mediumstring or nulloptional
Default null. Up to 100 characters.campaignstring or nulloptional
Default []. Up to 50 items.countriesstring[]optional
At least 1. At most 100.trafficintegeroptional
One of split, bandit.modestringoptionalstartAtstring or nulloptionalendAtstring or nulloptional
At least 1. At most 60.minDaysintegeroptional
Responses
200OKThe experiment.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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" }}Preview links for each variant
GET/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/linksKey required
Preview links for each variant. Permission: experiments:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Responses
200OK[{ key, name, url, frame }].dataobject[]Fields of data
keystringnamestringurlstringA preview link showing the variant.
framestring or nullThe same, to show in a frame.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/experiments/6650f1c2a9e4b1d2c3f40a30/links' \ -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
{ "data": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "frame": null } ]}Pauses it
POST/organisations/{organisationId}/spaces/{spaceId}/experiments/{experimentId}/pauseKey required
Pauses it. Permission: experiments:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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
variantstringrequiredThe winning variant's key, a to d. a is the original.
Responses
200OK{ experiment, contentId, requiresApproval, canPublish }.dataobjectPromoting doesn't publish: publish the page or send it for review afterwards.
Fields of data
experimentExperimentcontentIdstringAn id.
requiresApprovalbooleanThe page needs review before publishing.
canPublishbooleanThe 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Responses
200OKThe results.dataobjectFields of data
experimentExperimentdaysintegervisitorsPerDaynumber
One of collecting, keepGoing, winner, noDifference, controlWins, mismatch.verdictstringleaderstring or nullThe variant ahead.
daysLeftinteger or nullslowbooleanToo few visitors to finish in good time.
guidancestringWhat to do next, in English.
guidanceWordingobjectThe guidance as a translation key.
Fields of guidanceWording
keystringvaluesmap of any
srmobject or nullFields of srm
pValuenumbermismatchbooleanVisitors are not split as set, so the results can't be trusted.
armsobject[]Fields of arms
keystringnamestringcontrolbooleanvisitorsintegerconversionsintegerratenumberbeatControlnumber or nullThe chance it beats the original, 0 to 1.
bestnumberThe chance it's the best, 0 to 1.
upliftnumber or nullupliftLownumber or nullupliftHighnumber or nullexpectedLossnumber
guardrailsobject[]Fields of guardrails
keystringlabelstringarmsobject[]Fields of arms
keystringnamestringratenumberworsenumber
harmedstring[]
seriesobject[]Running totals by day.
Fields of series
daystringarmsmap of objectFields of arms
visitorsintegerconversionsintegerratenumber
dailyobject[]Each day's numbers.
Fields of daily
daystringarmsmap of objectFields of arms
visitorsintegerconversionsinteger
neededPerArminteger or nullVisitors each variant needs.
changesmap of any[]What each variant changes, by variant key.
One of cookieless, consent, cookie.assignmentstringinsightsany or any or nullsometimesWith 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestIt isn't a draft or scheduled, or isn't ready, such as a variant with no changes.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
Idempotency-KeystringheaderOptional. 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.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestThe experiment's state doesn't allow this, such as starting one that has ended.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
variantKeystringpath, requiredThe variant's key, a to d. a is the original.
Responses
200OK{ experiment, variant, fields, components, locked }.dataobjectFields of data
experimentExperimentvariantobjectFields of variant
keystringnamestringcontrolboolean
fieldsmap of anycomponentsBlock[]lockedstring or nullWhy 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
variantKeystringpath, requiredThe variant's key, a to d. a is the original.
Idempotency-KeystringheaderOptional. 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 anyoptionalThe variant's field values.
componentsBlock[]optionalThe variant's blocks.
Fields of components
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
variantstring or nullrequired
variantstring or nullrequired
variantstring or nullrequired
variantstring or nullrequired
Responses
200OK{ savedAt, changed }.dataobjectFields of data
savedAtstringchangedstring[]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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
experimentIdstringpath, requiredThe experiment's id.
variantKeystringpath, requiredThe variant's key, a to d. a is the original.
Idempotency-KeystringheaderOptional. 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.dataExperimentFields of data
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring
400Bad requestThe variant is locked or is the original.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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.
errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
variantstring or null
variantstring or null
variantstring or null
variantstring or null
Experiment
idstringAn id.
keystringnamestringhypothesisstring or null
One of draft, scheduled, running, paused, completed.statusstring
One of blocks, page.scopestringtargetBlockIdsstring[]pageobjectFields of page
idstringAn id.
namestringurlstring or nullpublishedboolean
scopeIdsobjectFields of scopeIds
environmentIdstringAn id.
regionIdstringAn id.
localeIdstringAn id.
variantsobject[]Fields of variants
keystringa is the original, then b, c and d.
namestringcontrolbooleanweightintegerchangedstring[]Blocks or fields that differ from the original.
editedboolean
trafficintegerPer cent of visitors in the experiment.
audienceobjectFields of audience
devicesstring[]
One of all, new, returning.visitorsstringutmobjectFields of utm
sourcestring or nullmediumstring or nullcampaignstring or null
countriesstring[]
goalobjectFields of goal
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
guardrailsobject[]Fields of guardrails
keystringlabelstringSuch as Booked a trip.
goalobjectWhat counts. page has path and match, event has name, insights has goalId, name and rule.
Fields of goal
One of click, form, engaged, page, event, insights.kindstring
One of split, bandit.modestringstartAtstring or nullendAtstring or nullminDaysintegerstartedAtstring or nullendedAtstring or nullwinnerstring or nullholdWinnerbooleanpromotedAtstring or nullcreatedAtstringupdatedAtstring