Personalized Recommendations API

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier to associate the Searchspring account making the request to the database. This can be found on the My Account page in the Searchspring Management Console under the Account details section.

Body Params
profiles
array of objects
required

the rec profiles you are requesting information from, along with profile specific parameters. This is required for POST requests

profiles*
products
array of strings

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.

products
blockedItems
array of strings

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.

blockedItems
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
array of strings

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.

cart
lastViewed
array of strings

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.

lastViewed
filters
array of objects

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.

filters
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.

boolean

Specify that this event is a test event - this prevents our tracking system from processing the event as a real user interaction.

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!