Last updated: Nov 06 2017

Area: Episerver Perform, Episerver Reach Applies to versions: 1.0 and higher (Server-to-Server API)

Recommendations response

If Recommendations were configured by Episerver for a page being tracked, a list of product recommendations is returned in the message.

The contents are returned in the smartRecs element at the root of the JSON response. The element contains product recommendations generated by the Episerver recommendations engine. These product recommendations are grouped by widget.

The value of smartRecs is a list of recommendation widget elements. These elements have the following properties.

  widget Name of the widget. [String] Use for information only; it may vary during A/B testing. To determine where to place a widget on the page, use the position attribute.
  alias Alias of the widget. [String] Use for information only.
  position Name of the page position for this widget. [String] Use to determine the page position in which to show this widget.
    recs A list of recommendations.  
      img URL of the product image. [String]
      title Product title. [String]
      url URL to the item's product page. [String]
      refCode Product reference code. [String]
      prices A map in which the key is the currency name (such as USD, GBP, and so on) and the value is a map with unitPrice and salePrice properties.  
        unitPrice The price per unit of the item. [Number]
        salePrice The sale price of the item. [Number]
      id Episerver recommendation ID. [64-bit Number]
      attributes A list of attributes and their values. Attributes required in the request. See Recommendations configuration.

To configure output details for the recommended product in the request, use the recContent request parameter.