Skip to content

Customer Panels

The pre-defined customer panels display products and variants or search phrases 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.

Abandoned carts panel

The result of a query to this panel is a list of products and variants that were added by a visitor to a shopping cart which didn't lead to a purchase. The list is ordered with the latest abandonment first. Maximum 10 abandoned cart items are indexed per visitor by eSales at any given time.

If a product is abandoned, all of its variants is returned in the result. If specific variants of a product are abandoned, only those variants will be returned with the product.

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
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.
Required argument.
5

Example panel content

The following example will use the panel arguments filter: category:'books', window_first: 1, and window_last: 10 to return abandoned products and variants.

The result attribute abandoned_timestamp is the time when the product was abandoned in milliseconds since UNIX epoch time.

JSON
{
  "resultType": "products",
  "products": [{
    "key": "P3",
    "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTsjOztOT05FOk5PTkU7NTE7",
    "abandoned_timestamp": "1325687990436",
    "variants": [{
      "key": "V1",
      "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMTs7Tk9ORTpOT05FOzM3Ow==",
      "attributes": {
        "custom_attribute": "value",
        "variant_key": "V1"
        }
      }
    ],
    "attributes": {
      "custom_attribute": "value1",
      "product_key": "P3",
      "rank": "1"
      }
    },
  {
    "key": "P4",
    "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzsjOztOT05FOk5PTkU7NTE7",
    "abandoned_timestamp": "1325687990357",
    "variants": [{
      "key": "V2",
      "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMTs7Tk9ORTpOT05FOzM3Ow==",
      "attributes": {
        "custom_attribute": "value",
        "variant_key": "V2"
      }
    },
    {
      "key": "V3",
      "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMjs7Tk9ORTpOT05FOzM3Ow====",
      "attributes": {
        "custom_attribute": "value",
        "variant_key": "V3"
        }
      }
    ]
    "attributes": {
      "custom_attribute": "value3",
      "product_key": "P4",
      "rank": "2"
      }
    },
  {
    "key": "P5",
    "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkU7NTE7",
    "abandoned_timestamp": "1325687990270",
    "variants": [],
    "attributes": {
      "custom_attribute": "value2",
      "product_key": "P5",
      "rank": "3"
      }
    }
  ]
} 

Recent searches panel

The result of a query to this panel is a list of the most recent search phrases a visitor has used. The list is ordered with the most recent search phrase first.

The search_attributes in the recent searches panel must match the search_attributes in the Search hits panel. A recommendation is to always use the same values for search_attributes in all panels involved in search, or to create a specific recent searches panel per search panel. Maximum 10 recent searches are indexed per visitor by eSales at any given time.

The arguments window_first and window_last must be included in a query to this panel.

Panel arguments

Name Type Description Example
search_attributes
Guide
string A comma-separated list of the product attributes used as search_attributes argument for the corresponding Search hits panel. Rank order will not be based on search if omitted in the query. name,brand
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.
Required argument.
5

Example panel content

The following example will use the panel arguments search_attribute: title, window_first: 1, and window_last: 3 to return recent searches.

JSON
{
   "resultType": "phrases",
   "phrases": [{
        "text": "eclipse",
        "ticket": "L3N0YXJ0LXBhZ2UvbGVmdC1jb2x1bW4vcmVjZW50LXNlYXJjaGVzO3RleHQ7",
        "rank": "1",
        "relevance": "0.0"
      },
      {
        "text": "tree of life",
        "ticket": "L3N0YXJ0LXBhZ2UvbGVmdC1jb2x1bW4vcmVjZW50LXNlYXJjaGVzO3RleHQ7Mw",
        "rank": "2",
        "relevance": "0.0"
      },
      {
        "text": "shrek",
        "ticket": "L3N0YXJ0LXBhZ2UvbGVmdC1jb2x1bW4vcmVjZW50LXNlYXJjaGVzO3RleHQ7Mg",
        "rank": "3",
        "relevance": "0.0"
      }
    ]
}

Recently bought panel

The result of a query to this panel is a list of products and variants that a visitor has bought in previous sessions. The list is ordered with the most recently bought product first, where each product contains the variants bought by the visitor. Variants are ordered with the most recently bought variant first. Maximum 10 bought items are indexed per visitor by eSales at any given time.

A query to this panel will return an empty result if no customer key can be associated with the current session.

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
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.
Required argument.
5

Example panel content

The following example will use the panel arguments filter: category:'books', window_first: 1, and window_last: 10 to return recently bought products and variants.

The result attribute bought_timestamp is the time when the product was abandoned in milliseconds since UNIX epoch time.

JSON
{
  "resultType": "products",
  "products": [{
    "key": "P2",
    "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTsjOztOT05FOk5PTkU7NTE7",
    "bought_timestamp": "1418119603521",
    "variants": [{
      "key": "V1",
      "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMTs7Tk9ORTpOT05FOzM3Ow==",
      "attributes": {
        "custom_attribute": "value",
        "variant_key": "V1"
        }
      },
      {
        "key": "V2",
        "ticket": "Oy9jYXlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWRlZ29yeS1wYWdlL3Byb2R1Y3QtbGN0X2tleORTpOT05FOzM3OwTtQMTtWMTs7Tk9==",
        "attributes": {
          "custom_attribute": "value",
          "variant_key": "V2"
        }
      }
    ],
    "attributes": {
      "custom_attribute": "value1",
      "product_key": "P2",
      "rank": "1"
      }
  },
  {
    "key": "P1",
    "ticket": "cm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkOy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7IztwU7NTE7",
    "bought_timestamp": "1417508532284",
    "variants": [],
    "attributes": {
      "custom_attribute": "value2",
      "product_key": "P1",
      "rank": "2"
      }
    }
  ]
}

Recently viewed panel

The result of a query to this panel is a list of products and variants that a visitor has recently viewed. The list is ordered with the most recently viewed product first, where each product contains the variants viewed by the visitor. Variants are ordered with the most recently viewed variant first. Maximum 10 recently viewed items are indexed per visitor by eSales at any given time.

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
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.
Required argument.
5

Example panel content

The following example will use the panel arguments filter: category:'books', window_first: 1, and window_last: 10 to return recently viewed products and variants.

The result attribute viewed_timestamp is the time when the product was abandoned in milliseconds since UNIX epoch time.

JSON
{
  "resultType": "products",
  "products": [{
    "key": "P2",
    "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTsjOztOT05FOk5PTkU7NTE7",
    "viewed_timestamp": "1418119603521",
    "variants": [{
      "key": "V1",
      "ticket": "Oy9jYXRlZ29yeS1wYWdlL3Byb2R1Y3QtbGlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTtWMTs7Tk9ORTpOT05FOzM3Ow==",
      "attributes": {
        "custom_attribute": "value",
        "variant_key": "V1"
        }
      },
      {
        "key": "V2",
        "ticket": "Oy9jYXlzdGluZy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWRlZ29yeS1wYWdlL3Byb2R1Y3QtbGN0X2tleORTpOT05FOzM3OwTtQMTtWMTs7Tk9==",
        "attributes": {
          "custom_attribute": "value",
          "variant_key": "V2"
        }
      }
    ],
    "attributes": {
      "custom_attribute": "value1",
      "product_key": "P2",
      "rank": "1"
      }
  },
  {
    "key": "P1",
    "ticket": "cm9kdWN0X2tleTtQMjsjOztOT05FOk5PTkOy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7IztwU7NTE7",
    "viewed_timestamp": "1417508532284",
    "variants": [],
    "attributes": {
      "custom_attribute": "value2",
      "product_key": "P1",
      "rank": "2"
      }
    }
  ]
}
×