User

This type represents an individual, such as a customer, user, or anonymous visitor. It includes the profile, statistics, and other personal information.

The user profile has predefined properties that are common to all users.

In addition to the properties listed below, the user profile supports additional properties called custom attributes.

Properties

These are the predefined properties of the user profile:

id

string

The user's unique identifier provided by the application, such as a UUID or a username.

name

string|null

The name of the user as a combination of their first and last name, separated by a space. For instance, "John Doe".

This property is virtual, meaning it is not stored in the user profile. Instead, it is derived from the first and last name.

firstName

string|null

The first name of the user. For example, "John".

lastName

string|null

The last name of the user. For example, "Doe".

age

integer|null

The age of the user. For example, 30.

This property is virtual, meaning it is not stored in the user profile. Instead, it is derived from the birth date.

birthDate

Date|null

The birth date of the user. For example, 1990-01-01.

gender

Gender

The gender of the user.

email

string|null

The email address of the user. For example, "john@example.com".

alternateEmail

string|null

The alternate email address of the user, such as a work email address or a secondary email address.

phone

string|null

The phone number of the user. For example, "+1 555 555 5555".

alternatePhone

string|null

The alternate phone number of the user, such as a work phone number or a secondary phone number.

address

Address|null

The address of the user.

avatar

URI|null

The URL of the user's avatar image.

company

string|null

The company the user works for.

companyUrl

URI|null

The URL of the company the user works for.

jobTitle

string|null

The job title of the user.

interests

set<string>

The set of interests the user demonstrates, with no duplicates. For example, "ab testing", "analytics", "data science", etc.

activities

set<string>

The set of activities the user performs, with no duplicates. For example, "ab testing", "analytics", "data science", etc.

stats

UserStatistics

The aggregate statistics about the user.

<attribute>

primitive|collection<primitive>|null

A custom attribute, where /*<attribute>*/ is the name of the attribute.

You can access any custom attribute just like any other property. For example, if you have defined a custom property named plan, you can access it like this:

user's plan

If a custom attribute has the same name as a predefined one, it takes precedence and hides the predefined attribute without overwriting it. Removing the custom attribute exposes the predefined one again.

Gender

These are the possible values and what they represent: