Preview

Preview represents the page structure and data to render a specific page preview.

Get page structure and data for a preview

GET
https://{project}-{customer}.frontastic.io/frontastic/preview

Returns the page structure and data for a specific preview by its previewId.

Headers:

  • Accept - application/json - Required
Path parameters:
project
String

Project Name

customer
String

Customer Name

Query parameters:
locale
Locale

Locale

previewId
String

Preview ID

Response:
200PagePreviewDataResponse
Request Example:cURL
curl --get https://{project}-{customer}.frontastic.io/frontastic/preview?locale={locale}&previewId={previewId} -i \
--header 'Accept: ${ACCEPT}'
200 Response Example: PagePreviewDataResponsejson
{
"previewId" : "4c2dc7eo",
"previewContext" : {
"customerName" : "demo"
},
"page" : {
"pageId" : "4e530bb93d40a78d11a26e2b04271rk3",
"sections" : {
"footer" : {
"sectionId" : "footer",
"layoutElements" : [ ]
},
"head" : {
"sectionId" : "head",
"layoutElements" : [ ]
},
"main" : {
"sectionId" : "main",
"layoutElements" : [ {
"layoutElementId" : "bfe4d755-e641-4791-9c57-d1010eacec84",
"configuration" : {
"size" : 12,
"mobile" : true,
"tablet" : true,
"desktop" : true
},
"tastics" : [ {
"tasticId" : "48185ef7-2cd2-4593-ac82-1909d0f64731",
"tasticType" : "example/star-wars/character-search",
"configuration" : {
"mobile" : true,
"tablet" : true,
"desktop" : true,
"data" : null
}
} ]
} ]
}
},
"state" : "default"
},
"pageFolder" : {
"pageFolderId" : "4e830bb93d40a78011a26e2f04223532",
"isDynamic" : false,
"pageFolderType" : "landingpage",
"configuration" : {
"path" : "star-wars",
"pathTranslations" : [ ]
},
"dataSourceConfigurations" : [ ],
"name" : "star-wars",
"ancestorIdsMaterializedPath" : "/4e530bb9fd40a78011a26e7b041e8cc3",
"depth" : 1,
"sort" : 0
},
"data" : {
"dataSources" : { }
}
}
Composable Commerce
Getting StartedMerchant CenterTutorialsHTTP APIGraphQL APIImport & ExportSDKs & Client LibrariesCustom Applications
Frontend
Getting StartedStudioDevelopingHTTP API
Sign upLog inSupportStatusOfferingTech BlogIntegrationsUser Research Program
Copyright © 2023 commercetools
Privacy PolicyImprint