Pages - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Pages

Page JSON representation

The top level page object in the JSON representation returned by a Delivery API's Pages endpoint request represents the actual page model. It contains a flattened list of objects that represents the page component hierarchy and associated content items and menus.

Each object is represented by a root element with a unique identifier as object name and has a type property indicating what type of object it is.

For example:

   "page":{
      "u1f0e3c3dc4c942bfb13130def8714ccd":{
          "type" : "component"
          ...
      },
      ...
      "ue00e981de17b43029559bbeee66df918":{
          "type" : "container" 
          ...
      }, 
      ...
      "u1ca07af9cdf54bdd9908f991245bb062":{
          "type" : "document"
          ...
      },
    }

Each object contained within a page is of one of the following types, grouped into three separately documented informal categories for convenience:

Components

  • type = component

  • type = container

  • type = container-item

Content items:

  • type = document

  • type = componentcontent

  • type = asset

  • type = imageset

Menus:

  • type = menu

SPAs can filter the objects based on their type property. For example, the frontend may not be interested in 'menu' objects on consecutive requests.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?