Pages Endpoint

GET /channels/{channel_id}/pages/{page_path}

Get the JSON representation of a page in a Bloomreach Content channel including all the components, content items, and menus of which that page is comprised.

Hierarchical structures such as the page component hierarchy or a navigation menu are serialized in a flattened representation.

See Pages JSON Representation for a full walkthrough of the response format.

Parameters

NameDescription
channel_id *

string

(path)
Channel id
page_path

string

(path)
Any number of path elements can be appended to the base endpoint URL to retrieve the representation for the corresponding page in a channel.

Examples:

  • /delivery/site/v1/channels/brxsaas/pages/
  • /delivery/site/v1/channels/brxsaas/pages/products/tools/
  • /delivery/site/v1/channels/brxsaas/pages/articles/changing-a-tap-washer
Authorization

string

(header)
ℹ️ The Authorization header is only required for previewing a channel in the Experience manager, not for regular public consumption of the API. Preview channel authentication is built into the Bloomreach SPA SDK. Channel preview works out of the box with any SPA built using the SDK. Only SPAs not using the SDK need to implement preview authentication

When the Experience manager requests the preview channel for the first time, it appends the external frontend application's URL with a 'query' request parameter containing a JSON Web Token. In order to access the preview channel data through a Page Delivery API request, the frontend application must include this token in the Authorization header using the Bearer schema. See Page Delivery API Preview Authentication for more details.

Mandatory in Experience manager channel preview context only

Example:

Authorization: Bearer xxxxx.yyyyy.zzzzz

Response

Code: 200
Description: OK Media type: application/json
Example:

{
   "meta":{   
      "product": "brx",
      "version":"1.0",
      "branch":"master"
   },
   "links":{
      "self":{
         "href":"https://example.brxsaas.bloomreach.cloud/site/api/brxsaas/page",
         "type":"external"
      },
      "site":{
         "href":"/",
         "type":"internal"
      }
   },
   "channel":{
      "info":{
         "props":{
            graphql_baseurl: "http://localhost:4000",
            "smDomainKey":"",
            "smAccountId":"1234",
            "smEndpoint":"https://core.dxpapi.com/api/v1/core/",
            "spaUrl":"https://brxm-react-spa.herokuapp.com/"
         }
      }
   },
   "root":{
      "$ref":"/page/u6b031ebfe46f46cd9ecdf430fa952f34"
   },
   "document":{
      "$ref":"/page/u10811792bf4b42c4bbf1ab303fc5ebcf"
   },
   "page":{
      "u6b031ebfe46f46cd9ecdf430fa952f34":{
         "type":"component",
         ...
         ]
      },
      ...
      ...
      ...
      "u10811792bf4b42c4bbf1ab303fc5ebcf":{
         "type":"document",
         ...
      }
   }
}

Code: 404
Description: Not Found