Search

👍

Dynamic Yield new Experience Search is coming soon!

We’re making product discovery smarter, more intuitive, and effortless with API-based image and semantic product searches.

For the request structure and examples, see the API Reference.

Search API provides seamless, personalized search and discovery experiences. It's similar to the Choose API and shares the same behavior and functionality in the following areas:

• Data centers and security
• Working with API keys
• Managing sessions and users: Necessary for accurately counting users and searches, and ensuring that metric attributions are reliable and consistent.
• Tracking product engagements (clicks): Necessary for measuring engagement with search results (that is, clicks on product tiles and adding items to the cart or wishlist, for example) and accurately reflecting the measurement in the main dashboard report.

However, some objects are structured a bit differently (see the API Reference for details). The main distinction of the Search endpoint lies in its use of the query object, which is needed to execute search requests.

Search API supports the following search solutions:

• Semantic Search: A native AI-powered, multi-modal search solution that uses both image and text embedding to deliver highly relevant search results for natural language queries.
• Visual Search: An image-based search solution that enables users to search using images and retrieve visually similar or relevant products.

Query object fields

Required

Note: Either imageBase64 or text must be provided, but not both in the same request.

Optional

Visual Search example

{
  "query": {
    "imageBase64": "bGlnaHQgd29yay4=...",
    "filters": [],
    "sortBy": {}
  },
}

Semantic Search example

{
  "query": {
    "text": "<query>",
    "filters": [],
    "pagination": {},
    "sortBy": {}
  },
}