curl --request GET \
--url https://cdn.xm.fabric.inc/api/pages/live \
--header 'x-site-context: <x-site-context>'
{
"status": 200,
"data": {
"livePages": [
{
"_id": "60788b398fad06000899bdc4",
"isArchived": false,
"channel": [
12
],
"channels": [
"12"
],
"status": "SCHEDULED",
"endDate": "2099-12-31T00:00:00.000Z",
"startDate": "2021-04-16T15:05:12.172Z",
"pageId": "60788b39f59a96c12ce27460",
"name": "KO v1",
"components": [
{
"_id": "6079db97f395c800086a1ceb",
"id": "Title",
"params": {
"title": "FAQ",
"subtitle": "Questions you may have around our commerce apps, getting started, security and compliance\"",
"components": [],
"additionalProp1": {}
},
"order": 1,
"additionalProp1": {}
},
{
"_id": "6079db97f395c800086a1cec",
"id": "PopularQuestions",
"params": {
"title": "POPULAR TOPICS",
"questions": [
{
"title": "Getting started",
"body": "Question 1",
"linkText": "Click here to view",
"linkUrl": "https://fabric.inc/"
}
],
"components": [],
"additionalProp1": {}
},
"order": 2,
"additionalProp1": {}
}
],
"versionId": 36,
"createdAt": "2021-04-15T18:51:37.475Z",
"updatedAt": "2021-04-26T16:40:24.212Z",
"__v": 0,
"page": {
"_id": "60788b39f59a96c12ce27460",
"name": "Popular FAQs",
"pageUrl": "/faq",
"__v": 0,
"channels": [
"12"
],
"createdAt": "2021-04-15T18:51:37.416Z",
"isActive": true,
"isArchived": false,
"pageId": 114,
"typeId": "60788b0bf59a96c12ce27214",
"updatedAt": "2021-04-26T16:40:24.253Z"
}
}
]
},
"code": "Ok",
"message": "List of Live Pages",
"service": "toby",
"status_code": 200,
"statusCode": 200
}
Returns a list of all the live pages
curl --request GET \
--url https://cdn.xm.fabric.inc/api/pages/live \
--header 'x-site-context: <x-site-context>'
{
"status": 200,
"data": {
"livePages": [
{
"_id": "60788b398fad06000899bdc4",
"isArchived": false,
"channel": [
12
],
"channels": [
"12"
],
"status": "SCHEDULED",
"endDate": "2099-12-31T00:00:00.000Z",
"startDate": "2021-04-16T15:05:12.172Z",
"pageId": "60788b39f59a96c12ce27460",
"name": "KO v1",
"components": [
{
"_id": "6079db97f395c800086a1ceb",
"id": "Title",
"params": {
"title": "FAQ",
"subtitle": "Questions you may have around our commerce apps, getting started, security and compliance\"",
"components": [],
"additionalProp1": {}
},
"order": 1,
"additionalProp1": {}
},
{
"_id": "6079db97f395c800086a1cec",
"id": "PopularQuestions",
"params": {
"title": "POPULAR TOPICS",
"questions": [
{
"title": "Getting started",
"body": "Question 1",
"linkText": "Click here to view",
"linkUrl": "https://fabric.inc/"
}
],
"components": [],
"additionalProp1": {}
},
"order": 2,
"additionalProp1": {}
}
],
"versionId": 36,
"createdAt": "2021-04-15T18:51:37.475Z",
"updatedAt": "2021-04-26T16:40:24.212Z",
"__v": 0,
"page": {
"_id": "60788b39f59a96c12ce27460",
"name": "Popular FAQs",
"pageUrl": "/faq",
"__v": 0,
"channels": [
"12"
],
"createdAt": "2021-04-15T18:51:37.416Z",
"isActive": true,
"isArchived": false,
"pageId": 114,
"typeId": "60788b0bf59a96c12ce27214",
"updatedAt": "2021-04-26T16:40:24.253Z"
}
}
]
},
"code": "Ok",
"message": "List of Live Pages",
"service": "toby",
"status_code": 200,
"statusCode": 200
}
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.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Successful operation
200 response object Attributes that are returned with all responses from Multi-tenant system
Was this page helpful?