Retrieves Live Pages

Returns a list of all the live pages

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.

Response

200 - application/json

200 response object

code

string

String message of response code

data

object

The data object holding the list of live page versions

Show child attributes

data.livePages

object[]

The array of live page versions

Show child attributes

data.livePages.__v

integer

The versionKey associated with the version

data.livePages._id

string

The database id associated with the version

data.livePages.channel

integer[]

A deprecated field holding channel information

data.livePages.channels

string[]

The channel ids associated with the version

data.livePages.components

object[]

The list of components

Show child attributes

data.livePages.components._id

string

The virtual id associated with the component

data.livePages.components.id

string

The identifier used in the UI by the component

data.livePages.components.params

object

The attached fields and values of the component

data.livePages.createdAt

string

The date and time the version was created

data.livePages.description

string

The description associated with the version

data.livePages.endDate

string

The date when the version will no longer be live

data.livePages.isArchived

boolean

True if the version is archived; false otherwise

data.livePages.name

string

The version name

data.livePages.page

object

The page object

Show child attributes

data.livePages.page.__v

integer

The versionKey associated with the page

data.livePages.page._id

string

The database id associated with the page

data.livePages.page.channel

integer[]

A deprecated field holding channel information

data.livePages.page.channels

string[]

The channel ids associated with the page

data.livePages.page.createdAt

string

The date and time the page was created

data.livePages.page.isActive

boolean

True if the page is active; false otherwise

data.livePages.page.isArchived

boolean

True if the page is archived; false otherwise

data.livePages.page.name

string

The page name

data.livePages.page.pageId

integer

An identifier used for the page

data.livePages.page.pageUrl

string

The relative page url

data.livePages.page.seoFields

object

The SEO fields

Show child attributes

data.livePages.page.seoFields._id

string

The virtual id associated with the SEO field

data.livePages.page.seoFields.createdAt

string

The date and time the SEO field was created

data.livePages.page.seoFields.description

string

SEO field description

data.livePages.page.seoFields.metadata

object[]

The list of metadata associated with the SEO field

Show child attributes

data.livePages.page.seoFields.title

string

SEO field title

data.livePages.page.seoFields.updatedAt

string

The date and time the SEO field was last updated

data.livePages.page.typeId

string

The database id for the page type that is linked to the page

data.livePages.page.typeName

string

Name of the page type of page (optional)

data.livePages.page.typeUrl

string

URL of the page type of page (optional)

data.livePages.page.updatedAt

string

The date and time the page was updated

data.livePages.pageId

string

The database id of the page associated with the version

data.livePages.startDate

string

The date and time the version was published

data.livePages.status

string

The current status of the version

data.livePages.updatedAt

string

The date and time the version was last updated

data.livePages.versionId

integer

An identifier used for the version

message

string

Description of response action

service

string

String specifying service returned this response

status

integer

The response status code

status_code

integer

Represents status code of response

statusCode

integer

Represents status code of response