User Properties
This page describes how to set or update user properties
Set custom User Properties (or User Attributes) through SDK. These attributes will be displayed in Apphud User Page and can be segmented in charts and filters. For example, you can view revenue or MRR chart segmented by your own user attribute.

Features:

  • Set user property using system reserved or custom keys
  • Increment user property with integer or floating value
  • Set once, so it will not be overwritten.

Usage examples

Swift
Objective-C
Kotlin
Flutter
Apphud.setUserProperty(key: .email, value: "[email protected]", setOnce: true)
Apphud.setUserProperty(key: .age, value: 31)
Apphud.setUserProperty(key: .init("custom_test_property_1"), value: true)
Apphud.setUserProperty(key: .gender, value: "male")
Apphud.setUserProperty(key: .init("custom_email"), value: "[email protected]", setOnce: true)
Apphud.incrementUserProperty(key: .age, by: 1)
Apphud.incrementUserProperty(key: .init("progress"), by: 0.5)
[Apphud setUserPropertyWithKey:[ApphudUserPropertyKey email] value:@"[email protected]" setOnce:YES];
[Apphud setUserPropertyWithKey:[ApphudUserPropertyKey age] value:@25 setOnce:false];
[Apphud setUserPropertyWithKey:[[ApphudUserPropertyKey alloc] init:@"custom_property"] value:@"test" setOnce:false];
[Apphud incrementUserPropertyWithKey:[[ApphudUserPropertyKey alloc] init:@"coins_count"] by:@5];
Apphud.setUserProperty(ApphudUserPropertyKey.Email, "[email protected]", true)
Apphud.setUserProperty(ApphudUserPropertyKey.CustomProperty("custom_increment_value_1"), 2.1f)
Apphud.setUserProperty(ApphudUserPropertyKey.Age, 29)
Apphud.incrementUserProperty(ApphudUserPropertyKey.CustomProperty("custom_increment_value_2"), 0.01f)
await AppHud.setUserProperty(key: ApphudUserPropertyKey.email, value:’[email protected]’ , setOnce:true);
await AppHud.setUserProperty(key: ApphudUserPropertyKey.age, value:31);
await AppHud.setUserProperty(key:ApphudUserPropertyKey.customProperty
(‘custom_test_property_1’), value:true);
await AppHud.setUserProperty(key:ApphudUserPropertyKey.gender, value:’male’);
await AppHud.setUserProperty(key:ApphudUserPropertyKey.customProperty
(‘custom_email’), value:’[email protected]’,setOnce:true);
await AppHud.incrementUserProperty( key: ApphudUserPropertyKey.age, by: 1,);
await AppHud.incrementUserProperty( key:ApphudUserPropertyKey.customProperty
(‘progress’), by: 0.5);

System Reserved User Properties

Key
Value
$email
String
$phone
String
$name
String
$cohort
String
$age
Int
$gender
Must be one of male, female, other

Limitations

  • Value must be one of: Int, Float, Double, Bool, String, NSNumber, NSString, NSNull, nil or null.
  • Key must be 30 characters maximum.
  • Each user may have maximum 50 attributes.
Copy link
On this page
Usage examples
System Reserved User Properties
Limitations