Skip to content

Product Panels

The pre-defined product panels all display product information 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.

Product information panel

The result of a query to this panel is a list of the products as specified in the panel arguments. The sort order of the products are according to positions of the product keys in the products argument. Product keys that are included in the query but not found will not be listed.

Panel arguments

Name Type Description Example
presentation_attributes
Guide
string A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted in query. title,brand,description
products string A comma-separated list of the product keys of the products that should be listed. Returns an empty result if omitted P1,P3,P2
variants_per_product int The maximum number of variants per product to include in the result. No maximum limit. 10

Example panel content

The following example will use the panel argument products: P1,P3,P2 to return product data.

JSON
{
  "resultType": "products",
  "products": [{
          "key": "P1",
          "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTsjOztOT05FOk5PTkU7NTE7",
          "variants": [{
                  "key": "V1",
                  "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMTs7Tk9ORTpOT05FOzM3Ow==",
                  "attributes": {
                      "custom_attribute": "value",
                      "variant_key": "V1"
                  }
              },
              {
                  "key": "V2",
                  "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMjs7Tk9ORTpOT05FOzM3Ow====",
                  "attributes": {
                      "custom_attribute": "value",
                      "variant_key": "V2"
                  }
              }
          ],
          "attributes": {
              "custom_attribute": "value1",
              "product_key": "P1",
              "rank": "1"
          }
      },
      {
          "key": "P3",
          "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzsjOztOT05FOk5PTkU7NTE7",
          "variants": [],
          "attributes": {
              "custom_attribute": "value3",
              "product_key": "P3",
              "rank": "2"
          }
      },
      {
          "key": "P2",
          "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkU7NTE7",
          "variants": [],
          "attributes": {
              "custom_attribute": "value2",
              "product_key": "P2",
              "rank": "3"
          }
      }
  ]
}

Those who bought also bought panel

The result of a query to this panel is a list of recommended product given a previous purchase. The sort order of the products are according to a product score. The score of a product, p, is equal to the number of visitors who bought the product p and also bought the product given in the product_key argument.

The result can be filtered through arguments to only include particular types of products and variants. The product given in the product_key argument is never included in the result.

Each product element in the result list specify all presentation attributes and the list rank of that product. Each product element also contain all its variants that match the filter ranked by sales.

An attribute proportion is returned for each product in the result. It is an integer value indicating the percentage of visitors that bought both the product defined by the argument product_key and a product returned in the result.

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 considered product and variant set. Defaults to UNIVERSE if omitted in query. color:'red' OR color:'blue' AND in_stock:'true'
presentation_attributes
Guide
string A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted in query. title,author
product_key string The product key to base the recommendations on.
Required argument.
P1
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: window_firstwindow_last ≤ 10 000.
Required argument.
5

Example panel content

The following example will use the panel arguments product_key: P1, window_first: 1, and window_last: 10 to return product data.

JSON
{
   "resultType": "products",
      "products": [{
              "key": "P2",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkU7NTE7",
              "variants": [{
                      "key": "P2_V1",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMTs7Tk9ORTpOT05FOzM3Ow====",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V1"
                      }
                  },
                  {
                      "key": "P2_V2",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMjs7Tk9ORTpOT05FOzM3Ow======",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V2"
                      }
                  }
              ],
              "attributes": {
                  "product_key": "P2",
                  "proportion": "50",
                  "rank": "1",
                  "custom_attribute": "value1"
              }
          },
          {
              "key": "P3",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzsjOztOT05FOk5PTkU7NTE7",
              "variants": [],
              "attributes": {
                  "product_key": "P3",
                  "proportion": "33",
                  "rank": "2",
                  "custom_attribute": "value2"
              }
          }
      ]
}

Those who viewed also viewed panel

The result of a query to this panel is a list of products that were viewed after a specified product was viewed. The sort order of the products are according to a product score. The score of a product, p, is equal to the number of sessions where where a visitor has clicked on the product given in the product_key argument and then clicked on the product p.

The result can be filtered through arguments to only include particular types of products and variants. The product given in the product_key argument is never included in the result.

Each product element in the result list specify all presentation attributes and the list rank of that product. Each product element also contain all its variants that match the filter ranked by sales.

An attribute proportion is returned for each product in the result. It is an integer value indicating the percentage of visitors that clicked both the product defined by the argument product_key and a product returned in the result.

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 considered product and variant set. Defaults to UNIVERSE if omitted in query. color:'red' OR color:'blue' AND in_stock:'true'
presentation_attributes
Guide
string A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted in query. title,author
product_key string The product key to base the recommendations on.
Required argument.
P1
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: window_firstwindow_last ≤ 10 000.
Required argument.
5

Example panel content

The following example will use the panel arguments product_key: P1, window_first: 1, and window_last: 10 to return product data.

JSON
{
   "resultType": "products",
      "products": [{
              "key": "P2",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkU7NTE7",
              "variants": [{
                      "key": "P2_V1",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMTs7Tk9ORTpOT05FOzM3Ow====",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V1"
                      }
                  },
                  {
                      "key": "P2_V2",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMjs7Tk9ORTpOT05FOzM3Ow======",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V2"
                      }
                  }
              ],
              "attributes": {
                  "product_key": "P2",
                  "proportion": "10",
                  "rank": "1",
                  "custom_attribute": "value1"
              }
          },
          {
              "key": "P3",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzsjOztOT05FOk5PTkU7NTE7",
              "variants": [],
              "attributes": {
                  "product_key": "P3",
                  "proportion": "3",
                  "rank": "2",
                  "custom_attribute": "value2"
              }
          }
      ]
}

Those who viewed bought panel

The result of a query to this panel is a list of products that were bought after a specified product was viewed. The sort order of the products are according to a product score. The score of a product, p, is equal to the number of sessions where where a visitor has clicked on the product given in the product_key argument and then bought the product p.

The result can be filtered through arguments to only include particular types of products and variants. The product given in the product_key argument is never included in the result.

Each product element in the result list specify all presentation attributes and the list rank of that product. Each product element also contain all its variants that match the filter ranked by sales.

An attribute proportion is returned for each product in the result. It is an integer value indicating the percentage of visitors that clicked both the product defined by the argument product_key and then bought a product returned in the result.

The arguments 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 considered product and variant set. Defaults to UNIVERSE if omitted in query color:'red' OR color:'blue' AND in_stock:'true'
presentation_attributes
Guide
string A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted in query. title,author
product_key string The product key to base the recommendations on.
Required argument.
P1
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: window_firstwindow_last ≤ 10 000.
Required argument.
5

Example panel content

The following example will use the panel arguments product_key: P1, window_first: 1, and window_last: 10 to return product data.

JSON
{
   "resultType": "products",
      "products": [{
              "key": "P2",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkU7NTE7",
              "variants": [{
                      "key": "P2_V1",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMTs7Tk9ORTpOT05FOzM3Ow====",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V1"
                      }
                  },
                  {
                      "key": "P2_V2",
                      "ticket": "Oy9kdWN1bWVudGF0aW9uL2V4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjtQMl9WMjs7Tk9ORTpOT05FOzM3Ow======",
                      "attributes": {
                          "custom_attribute": "value",
                          "variant_key": "V2"
                      }
                  }
              ],
              "attributes": {
                  "product_key": "P2",
                  "proportion": "5",
                  "rank": "1",
                  "custom_attribute": "value1"
              }
          },
          {
              "key": "P3",
              "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzsjOztOT05FOk5PTkU7NTE7",
              "variants": [],
              "attributes": {
                  "product_key": "P3",
                  "proportion": "2",
                  "rank": "2",
                  "custom_attribute": "value2"
              }
          }
      ]
}
×