Pages

An export of all page specifications in Elevate. It is possible to instead request a single page by providing a page id.

GET https://{cluster-id}.elevate-api.cloud/api/admin/v3/export/pages

Request

Request header parameters

Name	Description	Example
`Api-Key`*	API key supplied during onboarding.	`123456789..`
`Accept-Encoding`*	Allows responses to be compressed using gzip.	`gzip`

Request query parameters

Name	Description	Example
`market`*	The visitor market identifier. Must match the corresponding market identifier in the data feed.	`UK`
`idFilter`	A filter to instead return only the pages with the specific ids, if they exists. If provided, the returned object will be a PARTIAL import instead of a FULL import. Can contain at most 250 keys.	`page1,page2`
`outputFilter`	Whether to also include preview-stage changes or to instead export (deprecated) generated page templates (excluding preview- and published pages). Default is `PUBLISHED_ONLY`. Supported values: `PUBLISHED_ONLY`, `INCLUDE_UNPUBLISHED`, `GENERATED_ONLY`.	`PUBLISHED_ONLY`

Example request

bash

curl -i \
-X GET \
-H 'Api-Key: 123456789..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v3/export/pages?market=UK&idFilter=page1%2Cpage2&outputFilter=PUBLISHED_ONLY"

Response

Response codes

Status	Description
`200`	Query accepted. The data will be returned as an application/json-object.
`403`	Incorrect cluster credentials.
`404`	Cluster not found.
`406`	No acceptable encoding found in Accept-Encoding header.
`500`	Server error such as cluster unavailable, busy or internal error. If 5xx errors persist, contact support and attach any information found in the response body.
`503`	The server in the cluster that received the request is currently unavailable or busy. It is recommended to retry the request. The time between request attempts should be increasing.

Example response

{
  "market" : "se",
  "type" : "FULL",
  "addOrUpdate" : [ {
    "id" : "/women/shoes",
    "banners" : [ {
      "height" : 0,
      "id" : "BAN-1",
      "type" : "IMAGE",
      "width" : 0
    } ],
    "customData" : {
      "en-GB" : {
        "preamble" : "A carefully curated selection of products...",
        "bannerImage" : "/assets/banners/sale_01.jpg"
      }
    },
    "headings" : {
      "en-GB" : "Shoes"
    },
    "paths" : {
      "en-GB" : "/women/shoes"
    },
    "primaryList" : {
      "blocked" : [ "<PRODUCT_KEY_FROM_YOUR_FEED>" ],
      "facetsOverride" : {
        "enabled" : true,
        "facets" : [ {
          "attribute" : "brand",
          "sortOrder" : "RELEVANCE",
          "unit" : "cm",
          "useDefaults" : false,
          "visualization" : "VALUES"
        } ],
        "templateId" : null
      },
      "keywords" : {
        "additional" : {
          "en-GB" : [ "holiday", "vacation" ]
        },
        "enabled" : true,
        "headingAsKeyword" : true
      },
      "pageSliceInfo" : {
        "inherit" : false,
        "slices" : [ {
          "limit" : 0,
          "pinnedProducts" : [ "<PRODUCT_KEY_1>", "<PRODUCT_KEY_2>" ],
          "positions" : [ 0, 1, 5, 6 ],
          "productSetId" : "<PRODUCT_SET_ID_FROM_APP>",
          "sponsored" : true,
          "type" : "POSITIONED"
        } ]
      },
      "personalization" : {
        "enabled" : true,
        "personalization" : true
      },
      "pinned" : [ "<PRODUCT_KEY_FROM_YOUR_FEED>" ],
      "pinningSettings" : {
        "enabled" : true,
        "keepOutOfStockPinnings" : false
      },
      "productImages" : {
        "enabled" : true,
        "gallerySize" : 0,
        "hoverEffect" : null,
        "hoverImagePriority" : [ {
          "existsOnServer" : true,
          "index" : 0,
          "type" : null
        } ],
        "idleImagePriority" : [ {
          "existsOnServer" : true,
          "index" : 0,
          "type" : null
        } ],
        "imageGalleryPriority" : [ {
          "existsOnServer" : true,
          "index" : 0,
          "type" : null
        } ],
        "thumbnailPriority" : [ {
          "existsOnServer" : true,
          "index" : 0,
          "type" : null
        } ]
      },
      "restrictChildRules" : false,
      "rules" : "rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }",
      "sortOrderOverride" : {
        "enabled" : true,
        "sortOrders" : [ "PRICE_DESCENDING" ]
      }
    },
    "recLists" : [ {
      "id" : "PDP-1",
      "algorithm" : "TOP_PRODUCTS",
      "blocked" : [ "<PRODUCT_KEY_FROM_YOUR_FEED>" ],
      "limit" : 8,
      "pinned" : [ "<PRODUCT_KEY_FROM_YOUR_FEED>" ],
      "pinningSettings" : {
        "enabled" : true,
        "keepOutOfStockPinnings" : false
      },
      "rules" : "rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"
    } ],
    "sponsoredCategoryOverride" : [ null ],
    "sponsoredLists" : [ {
      "id" : "PDP-1",
      "category" : null,
      "limit" : 4
    } ]
  } ],
  "previewOnly" : true,
  "remove" : [ "/remove/me" ]
}

Response body schema

PageContainer

Name	Type	Description
market*	string	The market identifier to add pages to. Must match the corresponding market identifier in the data feed. Min length: `1`. Max length: `20`. Examples: `"se"`
type*	string	Type of import. Partial amends to the existing page collection, while full replaces the existing pages. Supported values: `FULL`, `PARTIAL`. Examples: `"FULL"`
addOrUpdate	Page[]	Pages to add or update. At most 3000 pages can be imported per market.
previewOnly	boolean	If true, the imported pages will only be pushed to a preview state to allow for testing before publishing the changes manually or through another import. Preview imports must use the `PARTIAL` type and can only contain updates or additions. They may not remove pages Default: `false`.
remove	string[]	Pages to remove, based on ids. Examples: `"/remove/me"`

Schemas

FacetSetting

Facet settings can be used to manually specify the facets of a primaryList on a page.

Name	Type	Description
attribute*	string	The name of the attribute, custom attributes should be prefixed with custom, e.g. brand and custom.attribute. Examples: `"brand"`
sortOrder	string	The sort order for the values of a facet. Certain attributes like, newness, does not require a sort order. Supported values: `RELEVANCE`, `ALPHABETIC`, `NATURAL`. Examples: `"RELEVANCE"`
unit	string	The unit for the values of a facet. Only applicable for attributes with units. Examples: `"cm"`
useDefaults	boolean	Indicates whether the facet should use settings from the facet configurator or take the supplied Examples: `false`
visualization	string	The visualization of a facet. Only applicable for custom typed number attributes. Supported values: `RANGE`, `VALUES`. Examples: `"VALUES"`

FacetsOverride

Facets override can be used to define which facets are going to be shown on a page. Optional: if not included the page will keep its current (or default) settings.

Name	Type	Description
enabled	boolean	Specify if the override should be used or not. True by default. Examples: `true`
facets	FacetSetting[]	The selected facets.
templateId	string	Specify which facet template that is used.

Keywords

Keywords can be used to increase the findability of products originating in the page. Optional: if not included the page will keep its current (or default) settings.

Name	Type	Description
additional	<string, string[]>	Specify per locale additional keywords to be used for the products on the page. Examples: `{"en-GB":["holiday","vacation"]}`
enabled	boolean	Specify if the override should be used or not. True by default. Examples: `true`
headingAsKeyword	boolean	Specify if the heading of primaryList should be used as a keyword. Examples: `true`

Page

Landing or category page to create.

Name	Type	Description
id*	string	Id of page, if a page with the same id already exists it’ll be amended to unless it’s a full import. Ids can consist of up to 200 characters and should be limited to alphanumeric characters, / and - Min length: `1`. Max length: `200`. Examples: `"/women/shoes"`
banners	PageBanner[]	Page banners to include. Requires that Retail Media is enabled for the cluster. Ids are limited to alphanumeric characters, _ and -. Max is 10
customData	<string, <string, string>>	A map of locales to extra custom data fields. The key-value mapping for a chosen locale will be returned in the result of landing-page requests. The key order is not guaranteed to be the same. Limited to 3000 characters and 200 keys per locale. Allowed characters for keys are alphanumerical, ’-’ and ’_‘ Examples: `{"en-GB":{"preamble":"A carefully curated selection of products...","bannerImage":"/assets/banners/sale_01.jpg"}}`
headings	<string, string>	A map of locales to the localised heading, normally the name of the navigation node or category. Headings can have at most 200 characters. Examples: `{"en-GB":"Shoes"}`
paths	<string, string>	A map of locales to the localised page path. If a page with the same path or id already exists it’ll be amended to unless it’s a full import. Examples: `{"en-GB":"/women/shoes"}`
primaryList	PagePrimaryList	Settings for the primary list on a landing or category page.
recLists	PageRecList[]	Recommendation lists to include. Be aware that having many lists with complex rules/algorithms on a page may affect response times. Ids are limited to alphanumeric characters, _ and -. Max is 10
sponsoredCategoryOverride	string[]	Categories to use as an override for Sponsored Lists and Slices where automatic category selection is used. The format is a category tree of up to three levels, separated by ’ > ‘
sponsoredLists	PageSponsoredList[]	Sponsored lists to include. Requires that Retail Media is enabled for the cluster. Ids are limited to alphanumeric characters, _ and -. Max is 10

PageBanner

Banner in a page. Requires that Retail Media is enabled for the cluster.

Name	Type	Description
height*	integer	The height of the banner.
id*	string	Per page unique identifier of a banner. Min length: `1`. Max length: `20`. Pattern: `[a-zA-Z0-9_-]+`. Examples: `"BAN-1"`
type*	string	The banner type. Supported values: `IMAGE`. Min length: `1`. Examples: `"IMAGE"`
width*	integer	The width of the banner.

PagePrimaryList

Settings for the primaryList on a landing or category page.

Name	Type	Description
blocked	string[]	The products to be excluded from the list. Optional: if not included the page will keep its current (or default) settings. Examples: `"<PRODUCT_KEY_FROM_YOUR_FEED>"`
facetsOverride	FacetsOverride	Used to override facet settings. If not included the page will keep its current (or default) settings.
keywords	Keywords	Search keywords relating to this page. If not included the page will keep its current (or default) settings.
pageSliceInfo	SliceInfo	Slices used on this page. If not included the page will keep its current (or default) settings.
personalization	Personalization	Settings for the personalization of this page. If not included the page will keep its current (or default) settings.
pinned	string[]	The products to be pinned at the start of the list. Optional: if not included the page will keep its current (or default) settings. Max is 100 pinned keys. Examples: `"<PRODUCT_KEY_FROM_YOUR_FEED>"`
pinningSettings	PinningSettings	Settings for pinned products on this list. If not included the page will keep its current (or default) settings.
productImages	ProductImages	Settings for the product images on a landing or category page.
restrictChildRules	boolean	Specify if child pages should inherit product rules. Only applicable if page id is a path, e.g. /women, and other pages have ids’ like /women/shoes.The products on /women/shoes page would already be limited to the rules specified on /women. Examples: `false`
rules	string	A logical expression used by Elevate to restrict the data set to a Product Selection. The rules can go from easy, such as to only include a product by its key or items that are in stock, to more complex expressions with multiple attributes for products at the same time. If no rules are provided, the entire data set will be used. Please note that when used in Landing Pages, the “Handpicked” rule must be the first rule, and must contain a set of product keys as its only condition. At most 100 product keys can be handpicked in a single request, and at most 200 attribute values can be supplied for each attribute. Examples: `"rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"`
sortOrderOverride	SortOrderOverride	Used to override sort order settings. If not included the page will keep its current (or default) settings.

PageRecList

Recommendation list of a page.

Name	Type	Description
id*	string	Per page unique identifier of a list. Min length: `1`. Max length: `20`. Pattern: `[a-zA-Z0-9_-]+`. Examples: `"PDP-1"`
algorithm	string	The recommendation algorithm to use. See here for more details. Supported values: `TOP_PRODUCTS`, `PERSONAL`, `NEWEST_PRODUCTS`, `FAVORITES`, `RECENTLY_VIEWED`, `RECENTLY_BOUGHT`. Examples: `"TOP_PRODUCTS"`
blocked	string[]	The products to be excluded from the list. Examples: `"<PRODUCT_KEY_FROM_YOUR_FEED>"`
limit	integer	The maximum number of product groups to receive on a recommendation list. Min: `1`. Max: `100`. Examples: `8`
pinned	string[]	The products to be pinned at the start of the list. Examples: `"<PRODUCT_KEY_FROM_YOUR_FEED>"`
pinningSettings	PinningSettings	Settings for pinned products on this list. If not included the list will keep its current (or default) settings.
rules	string	A logical expression used by Elevate to restrict the data set to a Product Selection. The rules can go from easy, such as to only include a product by its key or items that are in stock, to more complex expressions with multiple attributes for products at the same time. If no rules are provided, the entire data set will be used. Please note that when used in Landing Pages, the “Handpicked” rule must be the first rule, and must contain a set of product keys as its only condition. At most 100 product keys can be handpicked in a single request, and at most 200 attribute values can be supplied for each attribute. Examples: `"rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"`

PageSlice

Name	Type	Description
limit	integer	Optional limit of how many products from this slice’s selection should be displayed. Default is -1, which means no limit.
pinnedProducts	string[]	Pinned product keys in the specified slice. The maximum number is 50. Examples: `["<PRODUCT_KEY_1>","<PRODUCT_KEY_2>"]`
positions	integer[]	List of positions (starting at 0) where products from this slice should appear in the product list. Only used when type is `POSITIONED`. Examples: `[0,1,5,6]`
productSetId	string	The product set id of the slice. Min length: `1`. Examples: `"<PRODUCT_SET_ID_FROM_APP>"`
sponsored	boolean	Whether or not the slice should contain sponsored products. Requires that `limit` is also used on the slice. Default is `false`. For retail media only.
type	string	The type of slice. `SEQUENTIAL` (default) applies slices in order, from the top of the product list while `POSITIONED` uses explicit positions. All slices on a page must have the same type. Supported values: `SEQUENTIAL`, `POSITIONED`. Default: `SEQUENTIAL`. Examples: `"POSITIONED"`

PageSponsoredList

Sponsored list of a page. Requires that Retail Media is enabled for the cluster.

Name	Type	Description
id*	string	Per page unique identifier of a list. Min length: `1`. Max length: `20`. Pattern: `[a-zA-Z0-9_-]+`. Examples: `"PDP-1"`
category	string	The product category from which products compete to be included in the list. Keep empty to have Elevate automatically assign a category based on the page’s primary list. Min length: `1`. Max length: `1000`.
limit	integer	The maximum number of product groups to receive on the sponsored list. Min: `1`. Max: `100`. Examples: `4`

SliceInfo

Slices can be used to influence the order of products in the primary list. For more information about slices, see Slices

Name	Type	Description
inherit	boolean	Specify if child pages should inherit slice settings. Only applicable if page ID is a path, e.g. /women and other pages have IDs like /women/shoes. Default: `true`. Examples: `false`
slices	PageSlice[]	The slices used on the page. The maximum number is 100.

SortOrderOverride

The sort order override can be used to select which sort orders will be available to a primaryLists on page. Optional: if not included the page will keep its current (or default) settings.

Name	Type	Description
enabled	boolean	Specify if the override should be used or not. True by default. Examples: `true`
sortOrders	string[]	The selected sort orders for the primaryList. Min items: `1`. Max items: `2147483647`. Examples: `"PRICE_DESCENDING"`

OpenImagePriority

Name	Type	Description
existsOnServer	boolean
index	integer
type	string

Personalization

Name	Type	Description
enabled	boolean
personalization	boolean

PinningSettings

Settings for pinned products on a list.

Name	Type	Description
enabled	boolean	Whether the list overrides the market’s default pinning settings. Examples: `true`
keepOutOfStockPinnings	boolean	Whether pinned products should stay pinned when they are out of stock. When `false`, an out-of-stock pinned product is treated as not pinned. Examples: `false`

ProductImages

Name	Type	Description
enabled	boolean
gallerySize	integer	Min: `1`.
hoverEffect	string
hoverImagePriority	OpenImagePriority[]
idleImagePriority	OpenImagePriority[]
imageGalleryPriority	OpenImagePriority[]
thumbnailPriority	OpenImagePriority[]

Overview

Admin

Storefront

Request

Response

PageContainer

Schemas

FacetSetting

FacetsOverride

Keywords

Page

PageBanner

PagePrimaryList

PageRecList

PageSlice

PageSponsoredList

SliceInfo

SortOrderOverride

OpenImagePriority

Personalization

PinningSettings

ProductImages

​Request

​Response

​PageContainer

​Schemas

​FacetSetting

​FacetsOverride

​Keywords

​Page

​PageBanner

​PagePrimaryList

​PageRecList

​PageSlice

​PageSponsoredList

​SliceInfo

​SortOrderOverride

​OpenImagePriority

​Personalization

​PinningSettings

​ProductImages

Request

Response

PageContainer

Schemas

FacetSetting

FacetsOverride

Keywords

Page

PageBanner

PagePrimaryList

PageRecList

PageSlice

PageSponsoredList

SliceInfo

SortOrderOverride

OpenImagePriority

Personalization

PinningSettings

ProductImages