Skip to main content

StatsigUser Object

Introduction#

You should provide a StatsigUser object whenever possible when initializing the SDK, passing as much information as possible in order to take advantage of advanced gate and config conditions (like country or OS/browser level checks). Most of the time, the User ID field is needed in order to provide a consistent experience for a given user (see logged-out experiments to understand how to correctly run experiments for logged-out users). If the user is logged out at the SDK init time, you can leave out the User ID field, and Statsig will use a stable device ID that the SDK creates and stores in the local storage for targeting purposes.

User Attributes#

AttributesDescriptionExample
User IDID representing a unique user. This ID will be used to guarantee consistency of targeting for Feature Gates and Experiments and will be used to evaluate experiment results. If User ID is not provided, a Stable ID persisted locally will be used for evaluationsyour_user_id
EmailEmail of the usermarcos@statsig.com
User AgentUser agent of the browser. This will be decoded to determine the Browser and Operating System of the user's context. Will be inferred if not providedMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.40 Safari/537.36
IPIP address of the user. Will be inferred if not provided192.168.1.101
Country2 letter coutry code of the user. Will be inferred if not providedUS
LocaleLocale of the user. When using the Android or iOS SDK, will be inferred if not provideden_US
App VersionVersion of the app the user is using. When using the Android or iOS SDK, will be inferred if not provided1.0.1
CustomDictionary that can contain key/value pairs that can be used for Feature Gate targeting. The content of this dictionary will be stored and available after targeting{current_page: "/homepage", ...}
Private AttibutesDictionary that can contain key/value pairs that can be used for Feature Gate targeting. The content of this dictionary will not be stored after used for targeting and will be removed from any log_event calls{sensitive_field: "sensitive_information", ...}

Have sensitive user PII data that should not be logged?#

On the StatsigUser object, there is a field called privateAttributes, which is a simple object/dictionary that you can use to set private user attributes. Any attribute set in privateAttributes will only be used for evaluation/targeting, and removed from any logs before they are sent to Statsig server.

For example, if you have feature gates that should only pass for users with emails ending in "@statsig.com", but do not want to log your users' email addresses to Statsig, you can simply add the key-value pair { email: "my_user@statsig.com" } to privateAttributes on the user and that's it!

For more information, refer to the the privateAttributes guide.