GET
/
v2
/
page
/
live
{
  "status_code": 200,
  "message": "Live version: 2446 for page: /components",
  "data": {
    "page": {
      "_id": "613a76a15363f9e9575dc953",
      "name": "Components",
      "pageUrl": "/components",
      "__v": 0,
      "channels": [
        "00SZAU",
        "02SZCA"
      ],
      "createdAt": "2021-09-09T21:03:29.617Z",
      "isActive": true,
      "isArchived": false,
      "pageId": 1377,
      "seoFields": {
        "title": "SEO",
        "description": "SEO description",
        "_id": "612e4756c4b3c60010fff859",
        "metadata": [
          {
            "_id": "612e4756c4b3c60010fff85a",
            "name": "summary",
            "content": "Types of components",
            "createdAt": "2021-08-31T15:14:30.973Z",
            "updatedAt": "2021-08-31T15:14:30.973Z"
          }
        ],
        "createdAt": "2021-08-31T15:14:30.973Z",
        "updatedAt": "2021-08-31T15:14:30.973Z"
      },
      "updatedAt": "2021-10-14T20:31:46.794Z",
      "pageType": {
        "isDefault": false,
        "name": "Product category page",
        "urlPrefix": "/category"
      }
    },
    "version": [
      {
        "_id": "613a76a1fa9449000f6c36c3",
        "isArchived": false,
        "name": "Default",
        "channel": [
          12
        ],
        "channels": [
          "00SZAU",
          "02SZCA"
        ],
        "createdAt": "2021-09-09T21:03:29.712Z",
        "updatedAt": "2021-10-14T20:31:47.369Z",
        "components": {
          "_id": "61689237068cae000f12ef90",
          "id": "AboutUs",
          "params": {
            "desktopHeroImage": {
              "url": "https://imgurl.com/path/myPhoto.jpg",
              "altText": "Custom image"
            },
            "aboutUsContent": [
              {
                "text": "About us",
                "firstText": "Our Company",
                "secondText": "Our mission",
                "thirdText": "Our values",
                "paragraph": false,
                "dialog": false,
                "components": []
              }
            ],
            "components": [],
            "additionalProp1": {}
          },
          "order": 1,
          "additionalProp1": {}
        },
        "endDate": "2099-12-31T00:00:00.000Z",
        "pageId": "613a76a15363f9e9575dc953",
        "status": "SCHEDULED",
        "versionId": 2446,
        "__v": 0,
        "startDate": "2021-10-14T20:31:44.052Z"
      }
    ]
  }
}

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.

Query Parameters

url
string
required

Relative page url for which to retrieve the live page version

channels
string
default: 12

Comma-separated list of channel IDs

Response

200 - application/json

200 response object

status_code
integer

Response status code

message
string

Status message

data
object

Data object holding the live page and version details

Was this page helpful?

Get meta information about live pagesOverview