Introduction
The Delivery API's Pages endpoint returns a JSON representation of a page in a channel, including all the components, content items, and menus of which that page is comprised.
This documentation page introduces the top-level elements in the JSON. The actual page representation which, depending on the complexity of the page it represents, can be quite large, is further explained in more detailed documentation on its elements.
Top-level objects
The example below shows the top-level objects in the JSON:
{
"meta":{
"visitor":{
"id":"4b1793a2-c77d-47a9-bae6-f126dc24b0b2",
"header":"_visitor",
"new":false
},
"visit":{
"id":"f602fe2f-9639-4c5c-82c5-38bbba7e47a1",
"new":true
},
"version":"1.0",
"branch":"master",
locale": "en_US"
},
"links":{
"self":{
"href":"https://brxsaas.bloomreach.cloud/delivery/site/v1/channels/brxsaas/pages/winter-sale",
"type":"external"
},
"site":{
"href":"/winter-sale",
"type":"internal"
}
},
"channel":{
"info":{
"props":{
"smDomainKey":"",
"smAccountId":"1234",
"smEndpoint":"https://core.dxpapi.com/api/v1/core/",
"spaUrl":"https://brxm-react-spa.herokuapp.com/"
}
}
},
"translations": [
{
"locale": "nl_NL",
"channel": "brxsaas-nl",
"links": {
"site": {
"href": "https://brxsaas.bloomreach.cloud/delivery/site/v1/channels/brxsaas-nl/winter-sale",
"type": "external"
},
"self": {
"href": "https://brxsaas.bloomreach.cloud/delivery/site/v1/channels/brxsaas-nl/pages/winter-sale",
"type": "external"
}
}
}
],
"root":{
"$ref":"/page/u6b031ebfe46f46cd9ecdf430fa952f34"
},
"document":{
"$ref":"/page/u10811792bf4b42c4bbf1ab303fc5ebcf"
},
"page":{
"u6b031ebfe46f46cd9ecdf430fa952f34":{
"type":"component",
...
]
},
...
...
...
"u10811792bf4b42c4bbf1ab303fc5ebcf":{
"type":"document",
...
}
}
}
The top level objects are:
- meta
Meta information about the request includes the API version in use, channel configuration branch in use, the channel's locale, and (optionally) current visitor and visit data used by the Content audiences feature. - links
External and internal links to the page represented by this response. - channel
Information about the channel including the URL for the external SPA frontend and (optionally) Search & Merchandising connection info. - translations
Links to any translations of the page. - root
JSON reference to the root component in the flattened representation of the page component hierarchy (in the page top level element, see below). - document
JSON reference to the primary content item associated with the page - page
The actual page representation containing a flattened hierarchy of page components and associated content items and menus.
Page representation details
The top level page object represents the actual page representation and, along with the several different object types it contains, is described in detail on the following documentation pages: