Get Recommendations

Your AIQUA app ID.

The recommendation scenario's ID.

Required. The user_id of the user being served recommendations.

The number of recommended products to return. Valid values are 1 to 50. Default: 20.

Optional. A <a href="https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding" target="_blank">percent-encoded</a> JSON object specifying filtering rules to apply to the recommendation results. Only products that satisfy the filtering rules are returned.

To learn more about creating recommendation filters, see Defining API filtering rules.

Before percent-encoding, the filter object has the following structure:

{
  "version": 2,
  "filterRule": {
    "operator": "OR",
    "ruleList": [
      {
        "operator": "OR",
        "conditionList": [
          {
            "key": "category",
            "operator": "in",
            "value": ["3C", "Life"]
          }
        ]
      }
    ]
  }
}

Only required when using Category Hot Items models.

The category name is case sensitive. The value must be a left-to-right prefix of the product's category. For example, if a product's category is "Woman's > Pants > Blue Jeans":

• "Blue Jeans": doesn't match
• "Pants > Blue Jeans": doesn't match
• "Woman's > Pants": matches
• "Woman's > Pants > Blue Jeans": matches

If the category name includes special characters, it must be <a href="https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding" target="_blank">percent-encoded</a>.

The product ID as specified in your product data feed. Required for some recommendation models. See Recommendation model reference for a list of all recommendation models and their required parameters.