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

# Personalized Recommendations API

`GET /boost/{siteId}/recommend`

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

## Path parameters

- `siteId` string, required

## Query parameters

- `tags` string, required
- `products` string
- `blockedItems` string
- `categories` string
- `brands` string
- `shopper` string
- `cart` string
- `lastViewed` string
- `limits` string
- `filter` object — Filters the recommendations being returned. 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. Parameter names should be: "filter.[field]"; value is not case-sensitive. Examples: * filter.color=blue * filter.size=Large In order to use the range functionality the .low and/or .high should be appended after the field name. This is restricted to numerical values only. Examples: * filter.price.low=2 * filter.price.high=120
- `beacon` boolean
- `test` boolean

## Response `200`

OK

- object
  - `results` unknown[] — Array of objects that represent the relevant results returned after the database is queried. The way to modify the result data that is returned is through the passed query, and/or filter, and/or background filter parameter value(s).
    - unknown
  - `profile` object — Will return data that indicates which profile configured in the Searchspring Mangement Console is returning results data.
    - `tag` string — Will identify the unique profile tag that is returning results data.
  - `responseId` string — A uniquely generated ID used to identify the response. This ID is used by beacon tracking to associate user interactions with specific recommendation results.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Forbidden
- `404` — 404 Not Found
- `405` — 405 Method Not Allowed

---

[API](https://skmtc.dev/searchspring/apis/autocomplete-module.md) · [All operations](https://skmtc.dev/searchspring/apis/autocomplete-module/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/searchspring/autocomplete-module/revisions/04129662b4e5/schema)