API Reference / API Parameters / userToken

Feb. 26, 2019

userToken

Type: string

Engine default: user ip address

Parameter syntax

userToken => 'YourCustomUserId'

userToken: 'YourCustomUserId'

userToken: 'YourCustomUserId'

userToken: 'YourCustomUserId'

requestOptions.headers["X-Algolia-UserToken"] = "YourCustomUserId"

userToken: UserToken = UserToken("YourCustomUserId")

.setUserToken('YourCustomUserId')

.UserToken('YourCustomUserId')

.setUserToken('YourCustomUserId')

opt.UserToken("YourCustomUserId")

userToken = Some('YourCustomUserId')

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, searchForFacetValues Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Associates a certain user token with the current search.

Sending a user token will associate a search with a certain user. The insights taken from this could be used in combination with personalization for example. The user token has to be an alpha-numeric string with a maximum amount of 64 characters.

Examples

Set the user token

Copy

$index->search('query', ['userToken' => '123456'])

let index = client.index(withName: "your_index_name")
let requestOptions = RequestOptions()
requestOptions.headers["X-Algolia-UserToken"] = "123456"

index.search(
  Query(query: "s"),
  requestOptions: requestOptions,
  completionHandler: { (content, error) -> Void in
    if error == nil {
        print("Result: \(content!)")
    }
  }
)

Enable personalization for the current search and specify a user token

Copy

$index->search('query', [
  'enablePersonalization' => true,
  'userToken' => '123456'
]);

let index = client.index(withName: "your_index_name")
let requestOptions = RequestOptions()
requestOptions.headers["X-Algolia-UserToken"] = "123456"

let query = Query(query: "query")
query.enablePersonalization = true

index.search(
  query,
  requestOptions: requestOptions,
  completionHandler: { (content, error) -> Void in
    if error == nil {
        print("Result: \(content!)")
    }
  }
)

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

userToken

About this parameter

Examples

Set the user token

Enable personalization for the current search and specify a user token

Did you find this page helpful?

On this page