Set user token

About this method

Set the user token for all subsequent events sent to the Algolia Insights API.

Use this method to automatically send the userToken with every event.

Examples

The following example initializes the Insights API client aa. If the user isn’t identified initially, you can let the Insights API client generate an anonymous user token, and persist it in the cookies with the useCookie option.

For more information on how to initialize the aa object, refer to Initialize the Insights client.

1
2
3
4
5
aa('init', {
  appId: 'YourApplicationID',
  apiKey: 'YourSearchOnlyAPIKey',
  useCookie: true,
});

Then, keep track of the anonymous user token generated by the Insights API Client to restore it when the user logs out.

1
2
3
4
5
6
7
8
9
10
let anonymousUserToken;

aa('getUserToken', {}, (err, userToken) => {
  if (err) {
    console.error(err);
    return;
  }

  anonymousUserToken = userToken;
});

When the user logs in, synchronize the user token with the user ID coming from your system.

1
aa('setUserToken', 'YourUserID');

Finally, when the user logs out, restore the anonymous user token.

1
2
3
if (anonymousUserToken) {
  aa('setUserToken', anonymousUserToken);
}