Skip to main content
  • Type: string
  • Default: ""(user IP address)
  • Scope: search
The userToken parameter links a search request to a specific pseudonymous user.
It enables features that rely on user-level tracking, including:

​
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

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

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