Calling the Personalized Search API

Monetate's Personalized Search API is the search integration for your applications, allowing you to implement Personalized Site Search and Personalized Category Pages for your customers.
The basic Monetate Personalized Search API request is a POST call to the following URL:
Personalized Search API Endpoint
https://engine.monetate.net/api/search/v1/site-search/{name}/{instance}/{domain}/search
https://engine.monetate.net/api/search/v1/site-search/{name}/{instance}/{domain}/search
﻿
A request is comprised of two parts:
Suggestions: Automatic suggestions based on the text currently typed into the search field. Suggestions are updated live as the customer updates their search.
Queries: Complete results from a search. An individual result is called a record. Queries are returned after the customer formally sends their search request.
Both suggestions and queries can be included in a request.
Basic Request Code
Here's the basic Personalized Search API request:
Basic Personalized Search API Request
{
  "request": {
    "searchToken": "monetate-12345678987654321",
    "suggestions": [
      {
        ... Suggestions query 1 ...
      },
      {
        ... Suggestions query 2 ...
      }
    ],
    "recordQueries": [
      {
        ... Record query 1 ...
      },
      {
        ... Record query 2 ...
      }
    ]
  }
}
{
  "request": {
    "searchToken": "monetate-12345678987654321",
    "suggestions": [
      {
        ... Suggestions query 1 ...
      },
      {
        ... Suggestions query 2 ...
      }
    ],
    "recordQueries": [
      {
        ... Record query 1 ...
      },
      {
        ... Record query 2 ...
      }
    ]
  }
}
﻿
The search token is required for all Personalized Search API calls. It's obtained in the initial decision request.
Basic Response Code
The basic response is as follows:
Basic Personalized Search API Response
{
  "meta": {
    ...
  },
  "suggestionResults": [
    {
      ... Result of suggestions query 1 ...
    },
    {
      ... Result of suggestions query 2 ...
    }
  ],
  "queryResults": [
    {
      ... Result of record query 1 ...
    },
    {
      ... Result of record query 2 ...
    }
  ]
}
{
  "meta": {
    ...
  },
  "suggestionResults": [
    {
      ... Result of suggestions query 1 ...
    },
    {
      ... Result of suggestions query 2 ...
    }
  ],
  "queryResults": [
    {
      ... Result of record query 1 ...
    },
    {
      ... Result of record query 2 ...
    }
  ]
}
﻿
﻿
Updated 17 Jan 2025
Getting Started with the Personalized Search API
Auto-Suggestions