userToken

Pseudonymous user identifier

The userToken parameter links a search request to a specific pseudonymous user.
It enables features that rely on user-level tracking, including:

• Analytics
• NeuralSearch
• Personalization

Usage

• If not set explicitly, the user’s IP address is used as a fallback identifier.
• The same token should be used across all search, click, and conversion events for consistent behavior tracking.
• User token must not contain personally identifiable information.

For more information, see User token.

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", UserToken = "123456" })
);

Legacy API clients

C#

Query query = new Query("query");
query.UserToken = "123456";