Recommendation panels¶
The predefined recommendation panels all display product recommendations based on the parameters and incoming arguments that are sent with a panel query.
For mandatory arguments for all panels including request URL format, see Panel query.
Recommend based on cart panel¶
The result of a query to this panel is a list of recommended products given the products in a visitor's shopping cart. The products are ordered according to probability of purchase as calculated by Elevate. The result can be filtered to only include particular types of products. Products that are added to the shopping cart during the current and the most recent session are automatically filtered out of the result. Products that have previously been bought by the visitor are filtered out by default.
The result is a list of product elements, each specifying all presentation attributes and the list rank of that product. Each product contains all its variants that match the filter ranked by sales.
The arguments window_first and window_last must be included in a query to this panel.
Panel arguments¶
| Name | Type | Description | Example |
|---|---|---|---|
cart | string | A comma-separated list of product keys and/or variant keys. Returns an empty result if omitted in the query. | P1,P4,V3 |
filter Guide | filter | An expression limiting the possible product and variant set. Defaults to UNIVERSE if omitted in the query. | color:'red' OR color:'blue' AND in_stock:'true' |
presentation_attributes Guide | string | A comma-separated list of the attributes from product data to present. Default presentation attributes are used if omitted in the query. | title,author |
variants_per_product | int | The maximum number of variants per product to include in the result. No maximum limit. | 10 |
remove_recently_bought | boolean | A boolean indicating if the recent purchases of a visitor should be excluded from the result. Defaults to true if omitted in the query. | false |
window_first | int | The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1. Required argument. | 1 |
window_last | int | The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_first ≤ window_last ≤ 10 000. Required argument. | 5 |
Example panel content¶
The following example will use the panel arguments cart=0633225_en-US,0659854_en-US, window_first=1, and window_last=3 to return recommendation data.
JSON
{
"recommendBasedOnCart": [
{
"name": "recommend-based-on-cart",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjOyM7IzsjOyM7IzsjOw",
"path": "/recommend-based-on-cart",
"description": "Products that the visitor might want to buy, given the content of the shopping cart.",
"reportTag": "recommendation",
"displayName": "Recommend Based on Cart",
"attributes": {},
"resultType": "products",
"products": [
{
"key": "0519169_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA1MTkxNjlfZW4tVVM7MDUxOTE2OTAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"variants": [
{
"key": "0519169001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA1MTkxNjlfZW4tVVM7MDUxOTE2OTAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Beach Towel"
]
}
},
{
"key": "0413944_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA0MTM5NDRfZW4tVVM7MDQxMzk0NDAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"variants": [
{
"key": "0413944001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA0MTM5NDRfZW4tVVM7MDQxMzk0NDAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Short Running Tights"
]
}
},
{
"key": "0508229_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA1MDgyMjlfZW4tVVM7MDUwODIyOTAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"variants": [
{
"key": "0508229001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY2FydDsjO3Byb2R1Y3Rfa2V5OzA1MDgyMjlfZW4tVVM7MDUwODIyOTAwMV9lbi1VUzs7Tk9ORTpOT05FOzk7",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Shopper and clutch"
]
}
}
]
}
]
}
Recommend based on favorites panel¶
The result of a query to this panel is a list of recommended products given the products that a visitor has marked as favorites. The products are ordered according to probability of purchase as calculated by Elevate. The result can be filtered to only include particular types of products. Products that have previously been bought by the visitor are automatically filtered out of the result by default.
The result is a list of product elements, each specifying all presentation attributes and the list rank of that product. Each product contains all its variants that match the filter ranked by sales.
The arguments window_first and window_last must be included in a query to this panel.
If no products have been marked as favorites, an empty result will be returned.
Panel arguments¶
| Name | Type | Description | Example |
|---|---|---|---|
filter Guide | filter | An expression limiting the possible product and variant set. Defaults to UNIVERSE if omitted in the query. | color:'red' OR color:'blue' AND in_stock:'true' |
presentation_attributes Guide | string | A comma-separated list of the attributes from product data to present. Default presentation attributes are used if omitted in the query. | title,author |
variants_per_product | int | The maximum number of variants per product to include in the result. No maximum limit. | 10 |
remove_recently_bought | boolean | A boolean indicating if the recent purchases of a visitor should be excluded from the result. Defaults to true if omitted in the query. | false |
window_first | int | The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1. Required argument. | 1 |
window_last | int | The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_first ≤ window_last ≤ 10 000. Required argument. | 5 |
Example panel content¶
The following example will use the panel arguments window_first=1, and window_last=3 to return favorites data.
JSON
{
"recommendBasedOnFavorites": [
{
"name": "recommend-based-on-favorites",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7IzsjOyM7IzsjOyM7",
"path": "/recommend-based-on-favorites",
"description": "Products that the visitor might want to buy, given their favorites.",
"reportTag": "recommendation",
"displayName": "Recommend Based on Favorites",
"attributes": {},
"resultType": "products",
"products": [
{
"key": "0519169_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDUxOTE2OV9lbi1VUzswNTE5MTY5MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0519169001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDUxOTE2OV9lbi1VUzswNTE5MTY5MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Beach Towel"
]
}
},
{
"key": "0413944_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDQxMzk0NF9lbi1VUzswNDEzOTQ0MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0413944001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDQxMzk0NF9lbi1VUzswNDEzOTQ0MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Short Running Tights"
]
}
},
{
"key": "0508229_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDUwODIyOV9lbi1VUzswNTA4MjI5MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0508229001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tZmF2b3JpdGVzOyM7cHJvZHVjdF9rZXk7MDUwODIyOV9lbi1VUzswNTA4MjI5MDAxX2VuLVVTOztOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Shopper and clutch"
]
}
}
]
}
]
}
Recommend based on customer panel¶
The result of a query to this panel is a list of recommended products based on the history of clicks, previous purchases, and products added to shopping carts of a visitor. The products are ordered according to probability of purchase as calculated by Elevate based on the product selection used with the Personal sort order. The result can be filtered to only include particular types of products. Products that have previously been bought by the visitor are automatically filtered out of the result by default.
The result is a list of product elements, each specifying all presentation attributes and the list rank of that product. Each product contains all its variants that match the filter ranked by sales.
The arguments window_first and window_last must be included in a query to this panel.
Panel arguments¶
| Name | Type | Description | Example |
|---|---|---|---|
facets Guide | facets | A pipe-separated list of selected facet values. Used to limit the set of products and variants to use for the product count. Ignored if omitted in the query. | color:red|blue,size:6 |
filter Guide | filter | An expression limiting the possible product and variant set. Defaults to UNIVERSE if omitted in the query. | color:'red' OR color:'blue' AND in_stock:'true' |
presentation_attributes Guide | string | A comma-separated list of the attributes from product data to present. Default presentation attributes are used if omitted in the query. | title,author |
selected_category Guide | category | A selected category on the form: <tree name>:'<category key>'. Only products from this category and its sub-categories will be included in the result. Products from all categories are considered if omitted in the query. | category:'Ladies' |
variants_per_product | int | The maximum number of variants per product to include in the result. | 10 |
remove_recently_bought | boolean | A boolean indicating if the recent purchases of a visitor should be excluded from the result. Defaults to true if omitted in the query. | false |
window_first | int | The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1. Required argument. | 1 |
window_last | int | The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_first ≤ window_last ≤ 10 000. Required argument. | 5 |
Example panel content¶
The following example will use the panel arguments window_first=1, and window_last=3 to return recommendation data.
JSON
{
"recommendBasedOnCustomer": [
{
"name": "recommend-based-on-customer",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7IzsjOyM7IzsjOyM7Izs",
"path": "/recommend-based-on-customer",
"description": "Products that a specific customer might want to buy.",
"reportTag": "recommendation",
"displayName": "Recommend Based on Customer",
"attributes": {},
"resultType": "products",
"products": [
{
"key": "0523589_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNTIzNTg5X2VuLVVTOzA1MjM1ODkwMDFfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"variants": [
{
"key": "0523589001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNTIzNTg5X2VuLVVTOzA1MjM1ODkwMDFfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Leather Shoes"
]
}
},
{
"key": "0548793_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNTQ4NzkzX2VuLVVTOzA1NDg3OTMwMDRfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"variants": [
{
"key": "0548793004_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNTQ4NzkzX2VuLVVTOzA1NDg3OTMwMDRfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Bomber Jacket"
]
}
},
{
"key": "0715684_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNzE1Njg0X2VuLVVTOzA3MTU2ODQwMDFfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"variants": [
{
"key": "0715684001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tY3VzdG9tZXI7Iztwcm9kdWN0X2tleTswNzE1Njg0X2VuLVVTOzA3MTU2ODQwMDFfZW4tVVM7O05PTkU6Tk9ORTs5Ow",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Regular Fit Denim Shirt"
]
}
}
]
}
]
}
Recommend based on product panel¶
The result of this query to this panel is a list of recommended products given a specific product. This is intended for pages that display product information, for example when a user has clicked on a product and is routed to a page with more information about that specific product.
Recommendations are based on the product given in the product_key argument and relationship data between it and products it (including but not limited to) has been purchased or otherwise shared a shopping cart with. Other relationship data include click data and product filter attributes. The products are ordered according to probability of purchase as calculated by Elevate. The result can be filtered to only include particular types of products and variants.
The result is a list of product elements, each specifying all presentation attributes and the list rank of that product. Each product contains all its variants that match the filter ranked by sales.
The arguments product_key, window_first, and window_last must be included in a query to this panel.
Panel arguments¶
| Name | Type | Description | Example |
|---|---|---|---|
filter Guide | filter | An expression limiting the possible product and variant set. Defaults to UNIVERSE if omitted in the query. | color:'red' OR color:'blue' AND in_stock:'true' |
presentation_attributes Guide | string | A comma-separated list of the attributes from product data to present. Default presentation attributes are used if omitted in the query. | title,author |
product_key | string | The product key of a specific product. Can not be used in combination with variant_key Required argument. | P4 |
remove_recently_bought | boolean | A boolean indicating if the recent purchases of a visitor should be excluded from the result. Defaults to false if omitted in the query. | true |
variant_key | string | The variant key of a specific variant. Can be used instead but not in combination with product_key Required argument. | V1 |
variants_per_product | int | The maximum number of variants per product to include in the result. No maximum limit. | 10 |
window_first | int | The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1. Required argument. | 1 |
window_last | int | The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_first ≤ window_last ≤ 10 000. Required argument. | 5 |
Example panel content¶
The following example will use the panel arguments product_key=0633225_en-US, window_first=1, and window_last=3 to return recommendation data.
JSON
{
"recommendBasedOnProduct": [
{
"name": "recommend-based-on-product",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjOyM7IzsjOyM7IzsjOw",
"path": "/recommend-based-on-product",
"description": "Products that the visitor might want to buy, after viewing a specified product.",
"reportTag": "recommendation",
"displayName": "Recommend Based on Product",
"attributes": {},
"resultType": "products",
"products": [
{
"key": "0784271_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzA3ODQyNzFfZW4tVVM7MDc4NDI3MTAwMV9lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0784271001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzA3ODQyNzFfZW4tVVM7MDc4NDI3MTAwMV9lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Skinny Fit Wool Tuxedo Jacket"
]
}
},
{
"key": "0520221_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzA1MjAyMjFfZW4tVVM7MDUyMDIyMTAwMV9lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0520221001_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzA1MjAyMjFfZW4tVVM7MDUyMDIyMTAwMV9lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Cotton-blend Jacket"
]
}
},
{
"key": "0241602_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzAyNDE2MDJfZW4tVVM7MDI0MTYwMjAxN19lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"variants": [
{
"key": "0241602017_en-US",
"ticket": "Oy9yZWNvbW1lbmQtYmFzZWQtb24tcHJvZHVjdDsjO3Byb2R1Y3Rfa2V5OzAyNDE2MDJfZW4tVVM7MDI0MTYwMjAxN19lbi1VUztTWU4kMDtOT05FOk5PTkU7OTs",
"attributes": {}
}
],
"attributes": {
"product_name": [
"Blazer Slim fit"
]
}
}
]
}
]
}