Send User Properties

API reference for identifying users and setting custom properties

Identify users with custom IDs and attach properties for filtering, segmentation, and analytics.

Use Cases

  • Identify users across sessions and devices
  • Segment users by role, subscription, or other attributes
  • Filter sessions by user properties
  • Provide better support by finding specific users

Privacy Note: Avoid sending PII (email, phone) unless you have a DPA with UXCam. Use internal user IDs instead. Contact [email protected] for DPA details.


Set User Identity

Replace UXCam's auto-generated alias with your own user ID.

UXCam.setUserIdentity("user-123")
UXCam.setUserIdentity("user-123");
FlutterUxcam.setUserIdentity("user-123");
RNUxcam.setUserIdentity("user-123");
UXCam.SetUserIdentity("user-123");
UXCam.setUserIdentity("user-123");

Parameter: userIdentity (String) - Your unique identifier for the user.


Set User Property

Attach custom properties to users for filtering and segmentation.

UXCam.setUserProperty("subscription_type", value: "premium")
UXCam.setUserProperty("company_name", value: "Acme Inc")
UXCam.setUserProperty("subscription_type", "premium");
UXCam.setUserProperty("company_name", "Acme Inc");
FlutterUxcam.setUserProperty("subscription_type", "premium");
FlutterUxcam.setUserProperty("company_name", "Acme Inc");
RNUxcam.setUserProperty("subscription_type", "premium");
RNUxcam.setUserProperty("company_name", "Acme Inc");
UXCam.SetUserProperty("subscription_type", "premium");
UXCam.SetUserProperty("company_name", "Acme Inc");
UXCam.setUserProperty("subscription_type", "premium");
UXCam.setUserProperty("company_name", "Acme Inc");

API Parameters

ParameterTypeDescription
propertyNameStringName of the property
valueString or NumberValue to associate

Limits

LimitValue
User properties per user100
Property value typesString, Number

Example Properties

Common user properties to consider:

PropertyExample
roleadmin, user, guest
subscription_typefree, premium, enterprise
company_nameCompany identifier
acquisition_sourceorganic, paid, referral
nps_scoreNumeric rating

Platform Implementation Guides

PlatformGuide
AndroidUser Properties
iOSUser Properties
FlutterUser Properties
React NativeUser Properties