Skip to content

CMS Orbit delivery API

Read published content: pages, lists, menus, globals, campaigns, flags, sitemaps and the content model.

The delivery API is how a website reads published content. It is read only, and every endpoint answers with JSON in data. Errors come as error with a code and a message.

Send a delivery key with every request, in Authorization: Bearer or x-api-key. A public key (cms_pk_) may also go in the address as apiKey, so our CDN can cache the answer close to your visitors. A secret key (cms_sk_) reads drafts with draft=true and only works from a server: sent from another website's browser it is refused with 401.

Leave the trailing slash off endpoint addresses. Each key may make 60,000 requests a minute and each visitor's IP address 15,000. Answers carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (seconds until the minute starts again); over the limit the answer is 429 with Retry-After.

Lists are paged with page and perPage, and answer with total, page and hasMore.

Read the guideOpenAPI 3.1 document

Try it settings

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

Every request needs a delivery key. Paste a public key (cms_pk_) from Configuration › API keys in CMS Orbit, for the environment you call.

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.

PagesPages by their address, with fallback and redirects.

Resolve an address

GET/resolveKey required

Says what an address is: a page, a redirect, gone or not found. Call it before rendering a page, so redirects and removed pages behave correctly. Optional header x-cms-referrer: the page that linked here, recorded with addresses that are not found.

Parameters

  • urlstringquery

    The page address. A missing leading slash is added and a trailing slash removed.

    Default "/".
  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • strictstringquery

    true refuses every fallback: the page must exist in the language and region asked for.

    Only true.
  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.
  • includestringquery

    Extra content, separated by commas: references.

Responses

  • 200OKA page or a redirect.
    • dataResolved

      What an address is. The HTTP status follows kind.

      Fields of data

      One of:

      object

      object

      • kind"redirect"

      • destinationstring

        Where to send the visitor.

      • statusCodeinteger

        Such as 301.

      • permanentboolean

        true for 301 and 308.

      • hopsinteger

        Redirects followed to reach the final address.

      object

      • kind"gone"

      object

      • kind"notFound"

  • 400Bad requestAn include other than fields or references.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNothing was ever published here.
    • dataResolved

      What an address is. The HTTP status follows kind.

      Fields of data

      One of:

      object

      object

      • kind"redirect"

      • destinationstring

        Where to send the visitor.

      • statusCodeinteger

        Such as 301.

      • permanentboolean

        true for 301 and 308.

      • hopsinteger

        Redirects followed to reach the final address.

      object

      • kind"gone"

      object

      • kind"notFound"

  • 410GonePublished once and removed, or a campaign page that has ended.
    • dataResolved

      What an address is. The HTTP status follows kind.

      Fields of data

      One of:

      object

      object

      • kind"redirect"

      • destinationstring

        Where to send the visitor.

      • statusCodeinteger

        Such as 301.

      • permanentboolean

        true for 301 and 308.

      • hopsinteger

        Redirects followed to reach the final address.

      object

      • kind"gone"

      object

      • kind"notFound"

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/resolve' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "kind": "redirect",    "destination": "/gear/fjell-gtx-boot",    "statusCode": 301,    "permanent": true,    "hops": 1  }}

Get a page

GET/contentKey required

One page by its address. Use it when you only need the page and handle redirects yourself. It follows the language and region fallback unless strict=true.

Parameters

  • urlstringquery

    The page address. A missing leading slash is added and a trailing slash removed.

    Default "/".
  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • strictstringquery

    true refuses every fallback: the page must exist in the language and region asked for.

    Only true.
  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.
  • includestringquery

    Extra content, separated by commas: references.

Responses

  • 200OKThe page.
    • dataPage

      A published page, or its draft.

      Fields of data
      • idstring

        The entry's id in this region and language, the same as in the management API.

      • urlstring

        Such as /gear/fjell-gtx-boot.

      • namestring

      • contentTypestring

      • localestring

        The language that answered.

      • regionstring

        The region that answered.

      • requestedLocalestring

        What was asked for, or the default.

      • requestedRegionstring

        What was asked for, or the default.

      • fallbackAppliedboolean

        Another language answered.

      • regionFallbackAppliedboolean

        Another region answered.

      • draftboolean

      • publishedAtstring or null

        When it was last published.

      • versioninteger

        The published version, or the draft version for a draft.

      • fieldsmap of any

        The content type's fields. Images become Image objects and links carry the target page's current address. See https://docs.bifrostorbit.com/cms/developers/field-types/.

      • componentsComponent[]

        The page body.

        Fields of Component

      • seoSeo

        Ready-made metadata for the page.

        Fields of Seo

      • insightsobject or null

        Fields of insights
        • sitestring

          The Insights Orbit site key, public like the script tag.

      • expiredobjectsometimes

        Only on a campaign page past its end date that is set to stay visible.

        Fields of expired
        • messagestring

          Such as This offer has ended.

      • travelanysometimes

        On a Travel Orbit page: kind (trip, destination or guide), slug and the item under that name. See https://docs.bifrostorbit.com/cms/developers/travel-pages/.

      • experimentsanysometimes

        On a page with a running experiment: collect, assignment, tests and goals. See https://docs.bifrostorbit.com/cms/developers/experiments/.

  • 400Bad requestAn include other than fields or references.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNothing at the address.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/content' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a21",    "url": "/trips/lofoten-sea-kayaking",    "name": "Lofoten sea kayaking",    "contentType": "trip",    "locale": "en-GB",    "region": "norway",    "requestedLocale": "en-GB",    "requestedRegion": "norway",    "fallbackApplied": false,    "regionFallbackApplied": false,    "draft": false,    "publishedAt": "2026-11-02T09:30:00.000Z",    "version": 7,    "fields": {      "title": "Lofoten sea kayaking",      "days": 6,      "heroImage": {        "id": "6650f1c2a9e4b1d2c3f40a40",        "url": "https://media.northwilds.com/lofoten-kayaks.webp",        "mimeType": "image/webp",        "width": 2400,        "height": 1600,        "alt": "Kayaks on a calm fjord in Lofoten",        "title": null,        "subtitles": null,        "focalPoint": {          "x": 0.5,          "y": 0.6        }      }    },    "components": [      {        "id": "hero-1",        "type": "hero",        "schemaVersion": 1,        "fields": {          "heading": "Paddle the Lofoten fjords"        },        "children": {},        "variant": null      }    ],    "seo": {      "title": "Lofoten sea kayaking | Northwilds",      "description": "Six days paddling between the peaks of Lofoten, with a guide and camps on quiet beaches.",      "canonical": "https://northwilds.com/trips/lofoten-sea-kayaking",      "robots": {        "index": true,        "follow": true      },      "openGraph": {        "type": "website",        "title": "Lofoten sea kayaking",        "description": "Six days paddling between the peaks of Lofoten.",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "siteName": "Northwilds",        "locale": "en_GB",        "image": {          "url": "https://media.northwilds.com/lofoten-kayaks.webp",          "width": 1200,          "height": 630,          "alt": "Kayaks on a calm fjord in Lofoten"        }      },      "twitter": {        "card": "summary_large_image",        "site": null,        "title": "Lofoten sea kayaking",        "description": "Six days paddling between the peaks of Lofoten.",        "image": {          "url": "https://media.northwilds.com/lofoten-kayaks.webp",          "width": 1200,          "height": 630,          "alt": "Kayaks on a calm fjord in Lofoten"        }      },      "verification": {        "google": null,        "bing": null      },      "alternates": [        {          "hreflang": "en-GB",          "href": "https://northwilds.com/trips/lofoten-sea-kayaking"        },        {          "hreflang": "nb-NO",          "href": "https://northwilds.com/no/turer/lofoten-havpadling"        }      ],      "breadcrumbs": [        {          "name": "Trips",          "url": "https://northwilds.com/trips"        },        {          "name": "Lofoten sea kayaking",          "url": "https://northwilds.com/trips/lofoten-sea-kayaking"        }      ],      "jsonLd": []    },    "insights": null  }}

ListsEntries of one content type.

List entries

GET/listKey required

Entries of one content type, such as products, articles or FAQ entries. Items are summaries without a body. Add include=fields for each entry's fields too. Filter with filter[<field>]=<value>, such as filter[activity]=hiking: exact matches, repeat for several fields. Lists don't fall back to another language.

Parameters

  • typestringquery

    Content type key, such as product. Required in practice: without it the list is empty.

  • pageintegerquery

    1 or more.

    Default 1. At least 1.
  • perPageintegerquery

    1 to 100, 20 unless you say. Larger values are capped at 100.

    Default 20. At least 1. At most 100.
  • sortstringquery

    sortOrder (the editors' order, the default), name, -name, publishedAt, -publishedAt, updatedAt or -updatedAt.

    One of sortOrder, name, -name, publishedAt, -publishedAt, updatedAt, -updatedAt.
  • tagstringquery

    Entries whose tags field contains this.

  • categorystringquery

    Entries whose category field equals this.

  • qstringquery

    Entries whose name contains this text, ignoring case.

  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.
  • includestringquery

    Extra content, separated by commas: fields, references (which implies fields).

Responses

  • 200OKA page of entries. Ask for the next page while hasMore is true.
    • dataList

      Fields of data
      • itemsEntry[]

        Fields of Entry

      • totalinteger

        Matching entries across all pages.

      • pageinteger

      • hasMoreboolean

        Ask for the next page while true.

  • 400Bad requestAn unknown sort, a filter name that isn't a valid field key, or an unknown include.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/list' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "items": [      {        "id": "6650f1c2a9e4b1d2c3f40a21",        "url": "/trips/lofoten-sea-kayaking",        "name": "Lofoten sea kayaking",        "contentType": "trip",        "publishedAt": "2026-11-02T09:30:00.000Z"      },      {        "id": "6650f1c2a9e4b1d2c3f40a22",        "url": "/trips/jotunheimen-hut-to-hut",        "name": "Jotunheimen hut to hut",        "contentType": "trip",        "publishedAt": "2026-10-28T14:05:00.000Z"      }    ],    "total": 14,    "page": 1,    "hasMore": true  }}

Site-wide contentGlobals, menus, regions, taxonomies and the content model.

Get a global entry

GET/globalKey required

A global entry, such as the footer, by its key. It follows the language fallback, but not the region fallback.

Parameters

  • keystringquery, required

    The global entry's key.

  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • strictstringquery

    true refuses every fallback: the page must exist in the language and region asked for.

    Only true.
  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.
  • includestringquery

    Extra content, separated by commas: references.

Responses

  • 200OKThe entry.
    • dataGlobal

      Fields of data
      • keystring

      • namestring

      • contentTypestring

      • localestring

        The language that answered, which may be a fallback.

      • fieldsmap of any

      • componentsComponent[]

        Fields of Component

  • 400Bad requestAn include other than fields or references.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo global entry with that key.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/global?key=footer' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "key": "footer",    "name": "Footer",    "contentType": "footer",    "locale": "de-DE",    "fields": {      "copyright": "© Northwilds"    },    "components": []  }}

Get a menu

GET/navigationKey required

A menu, by its key. A menu can be shared by all regions or belong to one.

Parameters

  • keystringquery, required

    The menu key.

  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.

Responses

  • 200OKThe menu.
    • dataMenu

      Fields of data
      • keystring

      • namestring

      • itemsMenuItem[]

        Hidden items, and items linking to a page not published here, are left out.

        Fields of MenuItem

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo menu with that key.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/navigation?key=main' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "key": "main",    "name": "Main menu",    "items": [      {        "label": "Trips",        "href": "/trips",        "target": null,        "icon": null,        "badge": null,        "description": null,        "children": [          {            "label": "Lofoten sea kayaking",            "href": "/trips/lofoten-sea-kayaking",            "target": null,            "icon": null,            "badge": "New",            "description": null,            "children": []          }        ]      },      {        "label": "Gear",        "href": "/gear",        "target": null,        "icon": null,        "badge": null,        "description": null,        "children": []      },      {        "label": "Our Oslo shop",        "href": "/shop/oslo",        "target": null,        "icon": null,        "badge": null,        "description": "Try boots on in Grünerløkka",        "children": []      }    ]  }}

List regions

GET/regionsKey required

The regions the key may read, with their languages.

Responses

  • 200OKThe regions.
    • dataRegion[]

      Fields of data
      • keystring

        Such as germany.

      • namestring

      • localesobject[]

        Fields of locales
        • codestring

          Such as de-DE.

        • namestring

        • isDefaultboolean

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/regions' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": [    {      "key": "germany",      "name": "Germany",      "locales": [        {          "code": "de-DE",          "name": "German (Germany)",          "isDefault": true        },        {          "code": "en-DE",          "name": "English",          "isDefault": false        }      ]    }  ]}

Get a taxonomy

GET/taxonomies/{key}Key required

A taxonomy and its terms, in their set order.

Parameters

  • keystringpath, required

    The taxonomy's key.

  • regionstringquery

    Region key or short code, such as germany or de. Terms hidden in the region are left out, and its own labels win. The space's first region unless you say.

  • localestringquery

    Language for the term labels. A term without a label in it uses the language's fallback, then its default label.

Responses

  • 200OKThe taxonomy.
    • dataTaxonomy

      Fields of data
      • keystring

      • namestring

      • regionstring or null

        The region the labels and hidden terms follow, or null when the space has none.

      • termsobject[]

        Fields of terms
        • valuestring

        • labelstring

        • sortOrderinteger

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo taxonomy, or no region, with that key.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/taxonomies/activity' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "key": "activity",    "name": "Activity",    "region": "norway",    "terms": [      {        "value": "hiking",        "label": "Hiking",        "sortOrder": 0      },      {        "value": "kayaking",        "label": "Kayaking",        "sortOrder": 1      }    ]  }}

Get the content model

GET/schemaKey required

The space's content types and components, with their fields. The SDK's type generator uses it. Deprecated components and hidden fields are left out.

Responses

  • 200OKThe content model.
    • dataSchema

      Fields of data
      • contentTypesobject[]

        Fields of contentTypes
      • componentsobject[]

        Fields of components
        • keystring

        • namestring

        • descriptionstring or null

        • groupstring or null

        • allowedChildrenstring[] or "*"

        • fieldsSchemaField[]

          Fields of SchemaField

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/schema' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "contentTypes": [      {        "key": "trip",        "name": "Trip",        "description": "A trip with its departures.",        "isGlobal": false,        "fields": [          {            "key": "title",            "name": "Title",            "type": "text",            "required": true,            "description": null,            "options": null,            "allowedComponents": null,            "allowedContentTypes": null,            "taxonomy": null,            "validation": null,            "showWhen": null          },          {            "key": "days",            "name": "Days",            "type": "number",            "required": true,            "description": null,            "options": null,            "allowedComponents": null,            "allowedContentTypes": null,            "taxonomy": null,            "validation": null,            "showWhen": null          }        ]      }    ],    "components": [      {        "key": "hero",        "name": "Hero",        "description": null,        "group": "Page top",        "allowedChildren": [],        "fields": [          {            "key": "heading",            "name": "Heading",            "type": "text",            "required": true,            "description": null,            "options": null,            "allowedComponents": null,            "allowedContentTypes": null,            "taxonomy": null,            "validation": null,            "showWhen": null          }        ]      }    ]  }}

CampaignsBanners and popups live now.

List live banners

GET/bannersKey required

Banners live now for a page, pinned first and then by priority. serverTime lets countdowns tick from the CMS clock.

Parameters

  • pathstringquery

    The page being shown.

  • everyPagestringquery

    true returns the banners live on any page, each with the paths it targets, so a website can read them once. path is then ignored.

    Only true.
  • loggedInstringquery

    true when the visitor is signed in.

    Only true.
  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.

Responses

  • 200OKThe banners.
  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/banners' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "serverTime": "2026-11-02T09:30:00.000Z",    "items": [      {        "id": "6650f1c2a9e4b1d2c3f40a51",        "blocks": [          {            "id": "message-1",            "type": "message"          }        ],        "text": "Winter trips are open: book Lofoten by 30 November and save 10%",        "segments": [          {            "text": "Winter trips are open: ",            "highlight": false          },          {            "text": "book Lofoten by 30 November and save 10%",            "highlight": true          }        ],        "link": {          "kind": "url",          "href": "/trips/lofoten-sea-kayaking",          "target": null,          "label": "See the trip"        },        "background": "#1f2937",        "foreground": "white",        "placement": "aboveHeader",        "paths": [          "/trips/*"        ],        "addresses": [          "/trips/*"        ],        "pinned": false,        "priority": 10,        "trackingLabel": "winter-lofoten",        "countdown": null,        "endsAt": "2026-11-30T22:59:59.000Z",        "next": null      }    ]  }}

List live popups

GET/popupsKey required

Popups live now for a page and the visitor's sign-in state, highest priority first.

Parameters

  • pathstringquery

    The page being shown.

  • loggedInstringquery

    true when the visitor is signed in.

    Only true.
  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.

Responses

  • 200OKThe popups.
  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/popups' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "serverTime": "2026-11-02T09:30:00.000Z",    "items": [      {        "id": "6650f1c2a9e4b1d2c3f40a52",        "name": "Trip newsletter",        "layout": "corner",        "style": "light",        "minimisedText": "New trips",        "blocks": [          {            "id": "message-1",            "type": "message"          }        ],        "priority": 5,        "hideForDays": 30,        "maxViews": 3,        "trackingLabel": "newsletter-autumn",        "startsAt": null,        "endsAt": null      }    ]  }}

Feature flagsThe environment's flags.

Get feature flags

GET/flagsKey required

The feature flags of the key's environment, each true or false. A flag that isn't in the answer doesn't exist; treat it as off.

Responses

  • 200OKThe flags.
    • dataobject

      Fields of data
      • flagsmap of boolean

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/flags' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "flags": {      "new-booking-form": false,      "header-search": true    }  }}

ShopShop products with live prices and stock.

List shop products

GET/productsKey required

Shop products with live prices and stock, in their set order.

Parameters

  • pageintegerquery

    1 or more.

    Default 1. At least 1.
  • perPageintegerquery

    1 to 100, 24 unless you say. Larger values are capped at 100.

    Default 24. At least 1. At most 100.
  • filterstringquery

    A taxonomy term value. Products tagged with it in any taxonomy field match.

  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • draftstringquery

    true reads drafts instead of published content. Needs a secret key, from a server.

    Only true.

Responses

  • 200OKA page of products. Ask for the next page while hasMore is true.
    • dataProducts

      Fields of data
  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/products' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "items": [      {        "slug": "fjell-gtx-boot",        "url": "/gear/fjell-gtx-boot",        "name": "Fjell GTX boot",        "catalogId": "NW-FJELL-GTX-42",        "size": "EU 42",        "price": 2490,        "currency": "NOK",        "wasPrice": 2890,        "inStock": true,        "onSale": true,        "badges": [          "Waterproof"        ],        "benefits": [          "Waterproof membrane",          "Grippy sole for wet rock"        ],        "directions": null,        "ingredients": null,        "terms": null,        "images": [          {            "url": "https://media.northwilds.com/fjell-gtx-boot.webp",            "width": 1600,            "height": 1600,            "alt": "A brown leather hiking boot"          }        ],        "filters": [          {            "taxonomy": "activity",            "value": "hiking",            "label": "Hiking"          }        ],        "relatedSlugs": [          "merino-hiking-socks"        ],        "seo": {          "title": "Fjell GTX boot"        },        "publishedAt": "2026-11-02T09:30:00.000Z"      }    ],    "total": 1,    "page": 1,    "hasMore": false  }}

Travel OrbitTrips, destinations and guides when the space is connected to Travel Orbit.

List trips, destinations or guides

GET/travel/{key}Key required

Every trip, destination or guide from Travel Orbit, for trip finders, destination grids and team pages. A space that isn't connected gets empty lists. trips are priced in the currency of the region asked for, when they are sold in it.

Parameters

  • keystringpath, required

    trips, destinations or guides.

    One of trips, destinations, guides.
  • localestringquery

    Language, such as de or nb-NO. en unless you say.

  • regionstringquery

    Region key or short code, such as germany or de. The space's first region unless you say.

  • draftstringquery

    true reads with draft templates, for the website addresses in pageUrl. Needs a secret key.

    Only true.

Responses

  • 200OKThe list.
    • datamap of any[]

      Trips as in Trip fields without details; continents with their countries; or guides with slug, name, role, bio, photo, languages, tripCount and pageUrl.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundAnything other than trips, destinations or guides.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/travel/trips' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": [    {      "slug": "kari-nordmann",      "name": "Kari Nordmann",      "role": "Sea kayak guide",      "bio": "Kari has paddled the Lofoten coast for twelve summers.",      "photo": null,      "languages": [        "Norwegian",        "English"      ],      "tripCount": 3,      "pageUrl": "/guides/kari-nordmann"    }  ]}

Search enginesSitemaps and robots.txt.

Get the sitemap

GET/sitemapKey required

Without region, the index of every region and language. With region, that region's entries. Only published pages with an address are listed, without pages set to no-index or left out of the sitemap.

Parameters

  • regionstringquery

    Region key or code. Leave out for the index.

  • localestringquery

    Language code, such as de-DE. The region's default language unless you say.

  • pageintegerquery

    Sitemap file number. Each holds up to 50,000 addresses.

    Default 1. At least 1.

Responses

  • 200OKThe index, or one region's sitemap.
    • dataSitemapIndex or Sitemap

      Fields of data

      One of:

      SitemapIndex

      • indexableboolean

      • sitemapsobject[]

        Fields of sitemaps
        • regionstring

        • localestring

        • basestring or null

        • pagesinteger

        • filesinteger

          Sitemap files, up to 50,000 addresses each.

      Sitemap

      • regionstring

      • localestring

      • pageinteger

      • totalPagesinteger

      • entriesobject[]

        Fields of entries
        • locstring

        • lastmodstring or null

        • changefreqstring or null

        • prioritynumber or null

        • imagesobject[]

          Fields of images
          • locstring

          • titlestring or null

        • alternatesobject[]

          Fields of alternates
          • hreflangstring

          • hrefstring

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/sitemap' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "indexable": true,    "sitemaps": [      {        "region": "norway",        "locale": "en-GB",        "base": "https://northwilds.com",        "pages": 182,        "files": 1      },      {        "region": "norway",        "locale": "nb-NO",        "base": "https://northwilds.com/no",        "pages": 176,        "files": 1      }    ]  }}

Get robots.txt

GET/robotsKey required

The robots.txt for the environment. An environment that isn't indexable, such as staging, always gets User-agent: * and Disallow: /.

Responses

  • 200OKThe robots.txt.
    • dataobject

      Fields of data
      • indexableboolean

      • contentstring

      • indexNowKeystring or null

        The key the website serves at /<key>.txt so search engines accept CMS Orbit's IndexNow pings. Null when IndexNow is switched off or the environment isn't indexable.

  • 401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 402Payment requiredThe organisation's plan has ended, so delivery is paused.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

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

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl 'https://api.bifrostorbit.com/cms/v1/robots' \  -H 'Authorization: Bearer cms_pk_…'

Try it

Paste a public key above first.

Example answer

200 OKJSON
{  "data": {    "indexable": true,    "content": "User-agent: *\nAllow: /\nSitemap: https://northwilds.com/de/sitemap.xml\n",    "indexNowKey": "4d3ea0be0ee6893746b17db2b51ca5f4"  }}

ExperimentsThe collector for experiment events.

Count experiment events

POST/experiments/collectNo key

Exposures and conversions from visitors' browsers, up to 20 events and 16 KB. It needs no key and allows any origin. Only running experiments count. Requests without a user agent, from bots or with Do Not Track or Global Privacy Control get 204 and count nothing. The SDK calls it for you.

Request body

  • eobject[]required

    Up to 20 items.
    Fields of e
    • xstringrequired

      The experiment's key.

    • vstringrequired

      The visitor's key for this experiment.

    • tstringrequired

      exposure when the visitor sees their variant, conversion when they reach goals.

      One of exposure, conversion.
    • astringoptional

      For an exposure: the variant's key, a to d.

    • gstring[]optional

      For a conversion: the goal keys reached.

      Up to 5 items.

Responses

  • 200OKCounted.
    • dataobject

      Fields of data
      • acceptedinteger

  • 204No contentNot counted: a bot, Do Not Track or Global Privacy Control.
  • 400Bad requestA body that can't be read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 413Too largeOver 16 KB.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

  • 429Too many requestsToo many events from one address this minute.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
      • messagestring

        Such as Region not found.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/v1/experiments/collect' \  -H 'Content-Type: application/json' \  -d '{"e":[{"x":"k7m2qx9wpa","v":"1gpjbpa07yg5e0","t":"exposure","a":"b"}]}'

Try it

It counts towards real experiments.

Example answer

200 OKJSON
{  "data": {    "accepted": 1  }}

SchemasThe shapes the endpoints above answer with and take.

Error

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.
    • messagestring

      Such as Region not found.

Image

An image or file field, as delivered.

  • idstring

  • urlstring

    Change the size and format with the image address helpers in the SDK.

  • mimeTypestring

  • widthinteger or null

  • heightinteger or null

  • altstring

  • titlestring or null

  • subtitlesstring or null

    A video's subtitles file.

  • focalPointobject or null

    Fields of focalPoint
    • xnumber

      0 to 1 from the left.

    • ynumber

      0 to 1 from the top.

Seo

Ready-made metadata for the page.

  • titlestring

  • descriptionstring

  • canonicalstring

  • robotsobject

    Fields of robots
    • indexboolean

    • followboolean

  • openGraphobject

    Fields of openGraph
    • typestring

      One of website, article.
    • titlestring

    • descriptionstring

    • urlstring

    • siteNamestring

    • localestring

      Such as de_DE.

    • imageobject or null

      Fields of image
      • urlstring

      • widthinteger or null

      • heightinteger or null

      • altstring

  • twitterobject

    Fields of twitter
    • cardstring

      Only summary_large_image.
    • sitestring or null

    • titlestring

    • descriptionstring

    • imageobject or null

      Fields of image
      • urlstring

      • widthinteger or null

      • heightinteger or null

      • altstring

  • verificationobject

    Fields of verification
    • googlestring or null

    • bingstring or null

  • alternatesobject[]

    hreflang alternates.

    Fields of alternates
    • hreflangstring

    • hrefstring

  • breadcrumbsobject[]

    Fields of breadcrumbs
    • namestring

    • urlstring

  • jsonLdmap of any[]

    Structured data to put in script tags.

Component

One component in a page body. Blocks in a slot arrive both in children and on the slot's field.

  • idstring

  • typestring

    The component's key, such as hero.

  • schemaVersioninteger

  • fieldsmap of any

    The component's fields.

  • childrenmap of Component[]

    Blocks by slot.

    Fields of children
    • idstring

    • typestring

      The component's key, such as hero.

    • schemaVersioninteger

    • fieldsmap of any

      The component's fields.

    • childrenmap of Component[]

      Blocks by slot.

      Fields of children
      • idstring

      • typestring

        The component's key, such as hero.

      • schemaVersioninteger

      • fieldsmap of any

        The component's fields.

      • childrenmap of Component[]

        Blocks by slot.

        Fields of children
        • idstring

        • typestring

          The component's key, such as hero.

        • schemaVersioninteger

        • fieldsmap of any

          The component's fields.

        • childrenmap of Component[]

          Blocks by slot.

        • variantstring or null

      • variantstring or null

    • variantstring or null

  • variantstring or null

Page

A published page, or its draft.

  • idstring

    The entry's id in this region and language, the same as in the management API.

  • urlstring

    Such as /gear/fjell-gtx-boot.

  • namestring

  • contentTypestring

  • localestring

    The language that answered.

  • regionstring

    The region that answered.

  • requestedLocalestring

    What was asked for, or the default.

  • requestedRegionstring

    What was asked for, or the default.

  • fallbackAppliedboolean

    Another language answered.

  • regionFallbackAppliedboolean

    Another region answered.

  • draftboolean

  • publishedAtstring or null

    When it was last published.

  • versioninteger

    The published version, or the draft version for a draft.

  • fieldsmap of any

    The content type's fields. Images become Image objects and links carry the target page's current address. See https://docs.bifrostorbit.com/cms/developers/field-types/.

  • componentsComponent[]

    The page body.

    Fields of Component

  • seoSeo

    Ready-made metadata for the page.

    Fields of Seo

  • insightsobject or null

    Fields of insights
    • sitestring

      The Insights Orbit site key, public like the script tag.

  • expiredobjectsometimes

    Only on a campaign page past its end date that is set to stay visible.

    Fields of expired
    • messagestring

      Such as This offer has ended.

  • travelanysometimes

    On a Travel Orbit page: kind (trip, destination or guide), slug and the item under that name. See https://docs.bifrostorbit.com/cms/developers/travel-pages/.

  • experimentsanysometimes

    On a page with a running experiment: collect, assignment, tests and goals. See https://docs.bifrostorbit.com/cms/developers/experiments/.

Resolved

What an address is. The HTTP status follows kind.

One of:

object

object

  • kind"redirect"

  • destinationstring

    Where to send the visitor.

  • statusCodeinteger

    Such as 301.

  • permanentboolean

    true for 301 and 308.

  • hopsinteger

    Redirects followed to reach the final address.

object

  • kind"gone"

object

  • kind"notFound"

Entry

  • idstring

    The entry's id, the same value a Reference field holds.

  • urlstring or null

    null for an entry without its own address.

  • namestring

  • contentTypestring

  • publishedAtstring or null

  • seoany or any or nullsometimes

    The entry's SEO settings as editors saved them, such as title and description. null without an address, and left out when nothing was saved.

  • fieldsmap of anysometimes

    With include=fields or include=references.

SearchItem

  • idstring

    The entry's id in the language that answered.

  • urlstring or null

    null for an entry without its own address.

  • slugstring

  • namestring

  • contentTypestring

  • localestring

    The language that answered, which may be a fallback.

  • scorenumber

    Orders the entries within one answer. Not comparable between answers or modes.

  • snippetstring or null

    A short passage of the entry's text, around the words asked for when they appear.

  • fallbackAppliedboolean

    Another language answered, because the entry has no version in the language asked for.

SearchResult

  • itemsSearchItem[]

    Fields of SearchItem

  • totalinteger

    Entries found. Search looks only at the closest matches, so this is not a count of every entry that mentions the words.

  • hasMoreboolean

  • gravityobject

    Fields of gravity
    • modestring

      How the answer was found.

      One of hybrid, semantic, keyword.
    • fallbackboolean

      true when Gravity is off or can't be reached, and the answer has keyword results instead.

    • reasonstringsometimes

      Why it fell back.

      One of off, unavailable, busy, not_indexed.

List

  • itemsEntry[]

    Fields of Entry

  • totalinteger

    Matching entries across all pages.

  • pageinteger

  • hasMoreboolean

    Ask for the next page while true.

Global

  • keystring

  • namestring

  • contentTypestring

  • localestring

    The language that answered, which may be a fallback.

  • fieldsmap of any

  • componentsComponent[]

    Fields of Component

MenuItem

  • labelstring

  • hrefstring or null

    A page's current address, so renaming a page never breaks the menu.

  • targetstring or null

  • iconstring or null

  • badgestring or null

  • descriptionstring or null

  • childrenMenuItem[]

    The same shape as MenuItem

Menu

  • keystring

  • namestring

  • itemsMenuItem[]

    Hidden items, and items linking to a page not published here, are left out.

    Fields of MenuItem

Region

  • keystring

    Such as germany.

  • namestring

  • localesobject[]

    Fields of locales
    • codestring

      Such as de-DE.

    • namestring

    • isDefaultboolean

Taxonomy

  • keystring

  • namestring

  • regionstring or null

    The region the labels and hidden terms follow, or null when the space has none.

  • termsobject[]

    Fields of terms
    • valuestring

    • labelstring

    • sortOrderinteger

SchemaField

  • keystring

  • namestring

  • typestring

  • requiredboolean

  • descriptionstring or null

  • optionsobject[] or null

    Fields of options
    • labelstring

    • valuestring

  • allowedComponentsstring[] or null

  • allowedContentTypesstring[] or null

  • taxonomystring or null

  • validationmap of any or null

  • showWhenany or any or null

    Show the field only when another field has a value.

  • stepnumbersometimes

    A slider's step.

  • unitstringsometimes

    A slider's unit, such as km, to show after its value.

  • halfStarsbooleansometimes

    A star rating that allows half stars. Its number of stars is validation.max.

  • languagesstring[]sometimes

    The languages a code block allows.

Schema

  • contentTypesobject[]

    Fields of contentTypes
  • componentsobject[]

    Fields of components
    • keystring

    • namestring

    • descriptionstring or null

    • groupstring or null

    • allowedChildrenstring[] or "*"

    • fieldsSchemaField[]

      Fields of SchemaField

Countdown

  • labelstring or null

  • startsAtstring or null

  • endsAtstring or null

  • timeZonestring

  • stylestring

  • iconstring or null

  • buttonany or any or null

  • statusstring

    One of upcoming, running, ended.
  • displaystring

    One of countdown, hidden, followUp, ended.
  • followUpobject or null

    Fields of followUp
    • textstring

    • linkany or any or null

  • endedTextstring or null

Banner

  • idstring

  • blocksobject[]

    The blocks, for guests or signed-in visitors as asked.

    Fields of blocks
    • idstring

    • typestring

      Such as message or countdown.

  • textstring

    All the text, for a simple banner.

  • segmentsobject[]

    The text in parts, with the highlighted parts marked.

    Fields of segments
    • textstring

    • highlightboolean

  • linkany or any or null

    A link field: kind, href, target and label.

  • backgroundstring

    A colour, such as #1f2937.

  • foregroundstring

    The text colour the editor chose, or white or dark, whichever reads best on background.

  • placementstring

    One of aboveHeader, belowHeader.
  • pathsstring[]

    The pages it targets, with /* at the end for a whole section. Empty for every page.

  • addressesstring[]

    The full addresses of those pages, with the region's prefix.

  • pinnedboolean

  • priorityinteger

  • trackingLabelstring or null

  • countdownCountdown or any or null

    Fields of countdown

    One of:

    Countdown

    • labelstring or null

    • startsAtstring or null

    • endsAtstring or null

    • timeZonestring

    • stylestring

    • iconstring or null

    • buttonany or any or null

    • statusstring

      One of upcoming, running, ended.
    • displaystring

      One of countdown, hidden, followUp, ended.
    • followUpobject or null

      Fields of followUp
      • textstring

      • linkany or any or null

    • endedTextstring or null

    any or null

  • endsAtstring or null

  • nextobject or null

    The banner that takes over when this one ends.

    Fields of next
    • idstring

    • blocksobject[]

      The blocks, for guests or signed-in visitors as asked.

      Fields of blocks
      • idstring

      • typestring

        Such as message or countdown.

    • textstring

      All the text, for a simple banner.

    • segmentsobject[]

      The text in parts, with the highlighted parts marked.

      Fields of segments
      • textstring

      • highlightboolean

    • linkany or any or null

      A link field: kind, href, target and label.

    • backgroundstring

      A colour, such as #1f2937.

    • foregroundstring

      The text colour the editor chose, or white or dark, whichever reads best on background.

    • placementstring

      One of aboveHeader, belowHeader.
    • pathsstring[]

      The pages it targets, with /* at the end for a whole section. Empty for every page.

    • addressesstring[]

      The full addresses of those pages, with the region's prefix.

    • pinnedboolean

    • priorityinteger

    • trackingLabelstring or null

    • countdownCountdown or any or null

      Fields of countdown

      One of:

      Countdown

      • labelstring or null

      • startsAtstring or null

      • endsAtstring or null

      • timeZonestring

      • stylestring

      • iconstring or null

      • buttonany or any or null

      • statusstring

        One of upcoming, running, ended.
      • displaystring

        One of countdown, hidden, followUp, ended.
      • followUpobject or null

      • endedTextstring or null

      any or null

    • endsAtstring or null

    • startsAtstring

Popup

  • idstring

  • namestring

  • layoutstring

  • stylestring

  • minimisedTextstring or null

  • blocksobject[]

    The blocks, for guests or signed-in visitors as asked.

    Fields of blocks
    • idstring

    • typestring

      Such as message or countdown.

  • priorityinteger

  • hideForDaysinteger

    30 unless the editor says.

  • maxViewsinteger or null

  • trackingLabelstring or null

  • startsAtstring or null

  • endsAtstring or null

Product

  • slugstring

  • urlstring or null

  • namestring

  • catalogIdstring or null

    Links the product to the shop catalogue, which supplies price and inStock.

  • sizestring or null

  • pricenumber or null

    null when the product isn't linked or the catalogue can't be reached.

  • currencystring or null

  • wasPricenumber or null

  • inStockboolean or null

  • onSaleboolean

  • badgesstring[]

  • benefitsany

  • directionsany

  • ingredientsany

  • termsstring or null

  • imagesobject[]

    Fields of images
    • urlstring

    • widthinteger or null

    • heightinteger or null

    • altstring

  • filtersobject[]

    Fields of filters
    • taxonomystring or null

    • valuestring

    • labelstring

  • relatedSlugsstring[]

  • seoany

  • publishedAtstring or null

Products

SitemapIndex

  • indexableboolean

  • sitemapsobject[]

    Fields of sitemaps
    • regionstring

    • localestring

    • basestring or null

    • pagesinteger

    • filesinteger

      Sitemap files, up to 50,000 addresses each.

Sitemap

  • regionstring

  • localestring

  • pageinteger

  • totalPagesinteger

  • entriesobject[]

    Fields of entries
    • locstring

    • lastmodstring or null

    • changefreqstring or null

    • prioritynumber or null

    • imagesobject[]

      Fields of images
      • locstring

      • titlestring or null

    • alternatesobject[]

      Fields of alternates
      • hreflangstring

      • hrefstring