---
title: "Personalized Recommendations API"
method: POST
path: "/boost/{siteId}/recommend"
tags: [""]
---

# Personalized Recommendations API

`POST /boost/{siteId}/recommend`

## Request

- Base URL: `https://siteId.a.searchspring.io`
- URL: `https://siteId.a.searchspring.io/boost/{siteId}/recommend`
- Auth: none declared

Will return recommended products queried from a configured personalized recommendations profile. Returned results will be personalized to the shopper.

## Path parameters

- `siteId` string, required

## Request body

- object
  - `profiles` object[]: the rec profiles you are requesting information from, along with profile specific parameters. This is required for POST requests
    - `tag` string: Profile ID that is associated with a recommendations profile in the Searchspring Management Console.
    - `limit` integer: Sets the maximum number of products returned by a recommendation profile. Default is 20.
    - `categories` string[]: When using a Category Trending Recommendation Profile, the categories you want recommendations for are required.
    - `brands` string[]: When using a Brand Trending Recommendation Profile, the brands you want recommendations for are required.
    - `blockedItems` string[]: The IDs or SKUs you wish to block from being returned by the API in this profile's result set. Does not affect other profiles.
    - `dedupe` boolean: Sets whether or not this profile is subject to the recommendation API's deduplication logic. Default is true, meaning products across profiles are unique. This is useful for slideout carts where you would request recs for a cart that isn't immediately seen by the customer and you want to turn off deduplication logic for that profile.
    - `filters` object[]: Filters this profile's recommendations (does not apply to last viewed profiles or static custom profiles). If any filters are defined in the top level of the request body, they will be added, not overwritten. A field must have the Recs Filter column selected in the Field Settings page in the SMC in order to be used. Because the data science only creates so many recommendations for each product, there is a high chance of filtering out all of the recommendations; as such, this is best used when showing nothing is better than showing the wrong product.
      - `field` string: The rec filter field you wish to filter against
      - `type` 'equal' | 'notEqual' | 'lessThan' | 'greaterThan': The type of comparison you want
      - `values` string[]: the values to compare against, using multiple values followed OR logic. ex. Color is Black or Orange
    - `SearchTerm` string: Search term to be used on a dynamic custom profile. This parameter does nothing with any other type of profile.
  - `products` string[]: IDs or SKUs of the products being viewed. This parameter is required only for recommendations profiles that use cross-sell or similar recommendations types, and is recommended for all requests made on Product Detail Pages. This parameter will often just be a single value on a PDP but could be multiple on something like a view wishlist page or a page for a bundle of products.
  - `blockedItems` string[]: IDs or SKUs you wish to block from being returned by the API in this call. This is useful if you have other products that are being displayed on the page that you don't want returned by the recs API, potentially if you have curated products on the page.
  - `shopper` string: ID of current logged-in shopper from your ecommerce platform; this is required for personalization based on shopper history. If the shopper is anonymous, this parameter should be omitted.
  - `cart` string[]: IDs or SKUs that are in the current shopper's cart. This is required to curate recommended products as the shopper navigates the site. Required for cart cross-sell.
  - `lastViewed` string[]: IDs or SKUs that the shopper has recently viewed, with the most recently viewed product SKU listed first in the comma-seperated list. This parameter is required to curate recommended products as the shopper navigates the site.
  - `filters` object[]: Filters all the recommendations (does not apply to last viewed profiles or static custom profiles). If there are any profile-specific filters, these filters will be added to them, not overwritten. A field must have the Recs Filter column selected in the Field Settings page in the SMC in order to be used. Because the data science only creates so many recommendations for each product, there is a high chance of filtering out all of the recommendations; as such, this is best used when showing nothing is better than showing the wrong product.
    - `field` string: The rec filter field you wish to filter against
    - `type` 'equal' | 'notEqual' | 'lessThan' | 'greaterThan': The type of comparison you want
    - `values` string[]: the values to compare against, using multiple values followed OR logic. ex. Color is Black or Orange
  - `beacon` boolean: Specify wether or not using the new Beacon tracking system - this will tell the API to generate an auto-beacon event that is sent to our tracking system.
  - `test` boolean: Specify that this event is a test event - this prevents our tracking system from processing the event as a real user interaction.

---

[API](https://skmtc.dev/searchspring/apis/personalized-recommendations.md) - [All operations](https://skmtc.dev/searchspring/apis/personalized-recommendations/llms.txt) - [OpenAPI document](https://skmtc.dev/searchspring/apis/personalized-recommendations/revisions/665b5c1b171b?raw)