GET
/
page
/
live
curl --request GET \
  --url https://cdn.xm.fabric.inc/api/page/live \
  --header 'x-site-context: <x-site-context>'
{
  "status_code": 200,
  "message": "Live version: 39 for page: /home.",
  "data": {
    "page": {
      "_id": "6053609551ad48f797a786e8",
      "name": "Homepage",
      "pageUrl": "/home",
      "__v": 0,
      "channels": [
        "12"
      ],
      "createdAt": "2021-03-18T14:15:49.410Z",
      "isActive": true,
      "isArchived": false,
      "pageId": 106,
      "seoFields": {
        "title": "Knowledge Base Homepage",
        "description": "Welcome to our Knowledge Base!",
        "_id": "60897c9d892fa80008fb8fea",
        "metadata": [
          {
            "_id": "60897c9d892fa80008fb8feb",
            "name": "canonical",
            "content": "https://docs.fabric.inc",
            "updatedAt": "2021-04-28T15:17:49.027Z",
            "createdAt": "2021-04-28T15:17:49.027Z"
          }
        ],
        "updatedAt": "2021-04-28T15:17:49.027Z",
        "createdAt": "2021-04-28T15:17:49.027Z"
      },
      "updatedAt": "2021-04-30T18:21:38.022Z",
      "pageType": {
        "isDefault": false,
        "name": "Homepage",
        "urlPrefix": "/home"
      }
    },
    "version": [
      {
        "_id": "60802b257900a3000905e4d0",
        "isArchived": false,
        "channel": [
          12
        ],
        "channels": [
          "12"
        ],
        "status": "SCHEDULED",
        "endDate": "2099-12-31T00:00:00.000Z",
        "pageId": "6053609551ad48f797a786e8",
        "name": "Default v1",
        "description": "Default homepage",
        "components": [
          {
            "_id": "605ddce3068a620007becbb9",
            "id": "Title",
            "params": {
              "title": "Knowledge Base",
              "subtitle": "Explore our products and headless commerce solutions",
              "components": [],
              "additionalProp1": {}
            },
            "order": 1,
            "additionalProp1": {}
          },
          {
            "_id": "605de5dda877e000083bc851",
            "id": "Showcase",
            "params": {
              "items": [
                {
                  "title": "Enterprise commerce",
                  "blockColor": "blue",
                  "blockCustomColor": "#e3e5e9",
                  "linkText": "Learn more",
                  "linkUrl": "/start/enterprise-commerce",
                  "components": [],
                  "additionalProp1": {}
                }
              ]
            },
            "order": 2,
            "additionalProp1": {}
          }
        ],
        "versionId": 39,
        "createdAt": "2021-04-21T13:39:49.807Z",
        "updatedAt": "2021-04-30T18:21:37.993Z",
        "__v": 0,
        "startDate": "2021-04-22T19:55:22.791Z"
      }
    ]
  }
}

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
url
string
required

The relative page url for which to retrieve the live page version

Response

200
application/json

Successful operation

200 response object

GET
/
page
/
live
curl --request GET \
  --url https://cdn.xm.fabric.inc/api/page/live \
  --header 'x-site-context: <x-site-context>'
{
  "status_code": 200,
  "message": "Live version: 39 for page: /home.",
  "data": {
    "page": {
      "_id": "6053609551ad48f797a786e8",
      "name": "Homepage",
      "pageUrl": "/home",
      "__v": 0,
      "channels": [
        "12"
      ],
      "createdAt": "2021-03-18T14:15:49.410Z",
      "isActive": true,
      "isArchived": false,
      "pageId": 106,
      "seoFields": {
        "title": "Knowledge Base Homepage",
        "description": "Welcome to our Knowledge Base!",
        "_id": "60897c9d892fa80008fb8fea",
        "metadata": [
          {
            "_id": "60897c9d892fa80008fb8feb",
            "name": "canonical",
            "content": "https://docs.fabric.inc",
            "updatedAt": "2021-04-28T15:17:49.027Z",
            "createdAt": "2021-04-28T15:17:49.027Z"
          }
        ],
        "updatedAt": "2021-04-28T15:17:49.027Z",
        "createdAt": "2021-04-28T15:17:49.027Z"
      },
      "updatedAt": "2021-04-30T18:21:38.022Z",
      "pageType": {
        "isDefault": false,
        "name": "Homepage",
        "urlPrefix": "/home"
      }
    },
    "version": [
      {
        "_id": "60802b257900a3000905e4d0",
        "isArchived": false,
        "channel": [
          12
        ],
        "channels": [
          "12"
        ],
        "status": "SCHEDULED",
        "endDate": "2099-12-31T00:00:00.000Z",
        "pageId": "6053609551ad48f797a786e8",
        "name": "Default v1",
        "description": "Default homepage",
        "components": [
          {
            "_id": "605ddce3068a620007becbb9",
            "id": "Title",
            "params": {
              "title": "Knowledge Base",
              "subtitle": "Explore our products and headless commerce solutions",
              "components": [],
              "additionalProp1": {}
            },
            "order": 1,
            "additionalProp1": {}
          },
          {
            "_id": "605de5dda877e000083bc851",
            "id": "Showcase",
            "params": {
              "items": [
                {
                  "title": "Enterprise commerce",
                  "blockColor": "blue",
                  "blockCustomColor": "#e3e5e9",
                  "linkText": "Learn more",
                  "linkUrl": "/start/enterprise-commerce",
                  "components": [],
                  "additionalProp1": {}
                }
              ]
            },
            "order": 2,
            "additionalProp1": {}
          }
        ],
        "versionId": 39,
        "createdAt": "2021-04-21T13:39:49.807Z",
        "updatedAt": "2021-04-30T18:21:37.993Z",
        "__v": 0,
        "startDate": "2021-04-22T19:55:22.791Z"
      }
    ]
  }
}

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
url
string
required

The relative page url for which to retrieve the live page version

Response

200
application/json

Successful operation

200 response object