User and Account Model
This article lists the User and Account attributes in Gainsight PX and explains how to track the attributes.
Overview
Gainsight PX provides a set of User and Account attributes by default, and allows admin to define Custom attributes. Admins can turn ON/OFF the user, account and custom attributes as required. This allows for the Personally Identifiable Information(PII) or sensitive information of the end-users not to be tracked.
You can view the attributes by navigating to the Administration > Attributes page. Use the Attribute Name when sending data using the Gainsight PX Web SDK or the Gainsight PX REST API.
User Attributes
The following table lists the User Attributes:
View Name | Attribute Name | Data Type |
---|---|---|
Account id | accountId | String |
City Name | city | String |
Continent Code | continent | String |
Country Code | countryCode | String |
Country Name | countryName | String |
String | ||
First Name | firstName | String |
First visit | firstVisitDate | Date |
Gender | gender | String |
Guided Tours | guidedTours | Boolean |
Id | id | String |
Last name | lastName | String |
Latitude | latitude | String |
Lead date | leadDate | Date |
Longitude | longitude | String |
Number of visits | numberOfVisits | Number |
Onboarding Bot | onboardingBot | Boolean |
Phone | phone | String |
Postal Code | postalCode | String |
Product Updates | productUpdates | Boolean |
Region Name | regionName | String |
Role | role | String |
Score | score | Number |
Sign up date | signUpDate | Date |
State Code | stateCode | String |
State Name | stateName | String |
Street | street | String |
Subscription Id | subscriptionId | String |
Surveys | surveys | Boolean |
Time Zone | timeZone | String |
Job title | jobTitle | String |
Track Usage | trackUsage | Boolean |
Account Attributes
The following table lists the Account Attributes:
View Name | Attribute Name | Data Type |
---|---|---|
City Name | city | String |
Continent Code | continent | String |
Country Code | countryCode | String |
Country Name | countryName | String |
Id | id | String |
Industry | industry | String |
NAICS Code | naicsCode | String |
Name | name | String |
Number of employees | numberOfEmployees | Number |
Number of users | numberOfUsers | Number |
Number of visits | numberOfVisitors | Number |
Parent Group ID | parentGroupId | String |
Plan | plan | String |
Postal Code | postalCode | String |
Region Name | regionName | String |
Salesforce id | sfdcId | String |
SIC id | sicCode | String |
State Code | stateCode | String |
State Name | stateName | String |
Street | street | String |
Time Zone | timeZone | String |
Website | website | String |
Custom Attributes
If you do not see the field you like to pass into Gainsight PX in the available list of attributes, create a custom attribute.
To create a custom attribute:
- Navigate to Administration > Attributes.
- Click the +NEW button on the User or Account tab.
- On the Create Attribute pop up, enter the Attribute Name, API name.
- Select the Data Type and enter the Attribute Description.
- Enter the Default value for the attribute.
Note: When a custom attribute is used as a token and does not have a value then the default value replaces the token.
- Click Save.
Gainsight PX allows you to add up to 50 custom attributes. To add more attributes, contact us at pxsupport@gainsight.com.
Historical Tracking for Attributes
Gainsight PX has the capability of tracking the historical data for the Account and User Attributes. Users and Account properties such as roles, stage, status change frequently. The tracking option allows you to trace back the values for an attribute easily. Gainsight PX stores the following details:
- Past and current values of the attributes
- The date on which the attribute was updated
- The source from which the update was performed.
You can enable the tracking option while creating or editing the attribute.
Attribute Limits
Property Type | Limit (characters) |
---|---|
Attribute Name | 200 |
Attribute Value | 1024 |