Use the Personalization API when you want SuggestAPI to adapt search ranking for a specific user.

What it does

The Personalization API lets you store user-level context and behavior signals that can later influence /v1/autocomplete when you include a user_id.

That can help SuggestAPI rank results based on:

  • known preferences
  • previous interactions
  • category or brand affinity
  • other profile-level relevance signals supported by your configuration

Endpoints

  • POST /v1/personalization/profiles
  • GET /v1/personalization/profiles/{user_id}
  • DELETE /v1/personalization/profiles/{user_id}
  • POST /v1/personalization/events

Typical flow

  1. create or update a user profile
  2. send personalization events as the user interacts with search or product content
  3. pass user_id to /v1/autocomplete
  4. review ranking changes with debug output when needed

When to use it

Use personalization when the same query should not always return the same ranking order for every user.

Examples:

  • returning users with strong brand preferences
  • users shopping inside different verticals or use cases
  • users whose click history should shape future ranking