Identifying your users helps you find their sessions in the LogRocket dashboard.

Call LogRocket.identify() on page loads to associate your own application-specific user ID with the active user. These user identifiers will be referred to as "UIDs".

LogRocket.identify(uid);

You can use any string that uniquely identifies the user of your application, such as a database ID, an email, or a username.

If you do not provide a UID, the user will be assigned a random one and shown as "Anonymous" in the UI.

LogRocket.identify('123456') // an immutable ID from your database (preferred)
LogRocket.identify('foo@bar.com') // the user's email

It's recommended to use an immutable database ID if available. Names and email addresses can be added as user traits as they could change.

LogRocket.identify() can be called up to 10 times per page.

LogRocket.identify() also takes a JSON object as an optional second argument. This object can contain any key/value pair of data that you'd like to associate with the given user.

Specify Name and Email Address

If the name or email keys are given they will be displayed instead of the UID in the UI. They can also be used in the search box to quickly find user sessions:

LogRocket.identify('123456', {
  name: 'John Smith',
  email: 'johnsmith@gmail.com',
});

Specify other user traits

Other user information can also be given. This information will not be displayed in the session list directly, but can used for searching through sessions using the User Trait filter. They will also be displayed in the user details section of the session playback.

LogRocket.identify('123456', {
  name: 'Jane Smith',
  email: 'janesmith@logrocket.com',
  age: 43,
  favoriteColor: 'blue',
});

The user trait filter does not support filtering by a range of trait values but you can use the OR operator to add multiple values to the User Trait. This can then be saved as a Saved Segment and applied to the session list or within metrics.

📘
Here are a few gotchas to avoid while using LogRocket.identify:

LogRocket.identify only accepts strings as UIDs. Make sure to cast your UID to a string before calling this function.

There is no need to call LogRocket.identify for anonymous or logged out users. We use sessionStorage to persist sessions across pages for logged-out users.

If LogRocket.identify is called multiple times during a recording, you can search for any of the identified users in the session.

🚧
Custom user data is identified on the user and will be the same across all of their sessions. Use LogRocket.track() to add information to individual sessions.

🚧
When searching within LogRocket using the User Trait filter, please note that we limit the search to 512 characters. Any terms greater than this length will be discarded.