userToken
userToken => 'YourUserAnonymousId'
Can be used in these methods:
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse,
searchForFacetValues,
generateSecuredApiKey,
addAPIKey,
updateAPIKey
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
Search,
Browse,
SearchForFacetValues,
GenerateSecuredApiKeys,
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
About this parameter
Associates a certain user token with the current search.
Sending a user token associates a search with a certain user. This is essential for features like personalization. The user token should match the userToken
in events sent to the Insights API (also known as the anonymous user token, or session user token).
For more information about the correct format of a user token, see the Insights API reference.
Examples
Set the user token
1
$index->search('query', ['userToken' => '123456'])
Enable personalization for the current search and specify a user token
1
2
3
4
$index->search('query', [
'enablePersonalization' => true,
'userToken' => '123456'
]);