Custom Dimensions
Custom Dimensions allow you to annotate events with additional contextual information. These dimensions can help you segment players based on criteria specific to your game, which you can then use to filter, group and compare metrics in your analysis.
Common use cases:
- Segmenting players by type or player class (e.g. Warrior, Mage)
- Identifying feature usage (e.g. did a player enter a specific level or tutorial)
- Marking special campaigns or live-ops events
How to send Custom Dimensions
Custom Dimensions are defined in the SDK instrumentation phase, where you will need to define up to 20 unique values per dimension.
Refer to the SDK Documentation for code examples specific to your platform (Unity, Unreal, Roblox, iOS, Android, etc.).
Considerations
-
There are three custom dimensions available to send: custom_01, custom_02 and custom_03.
-
When instrumented, these dimensions are sent with every event type.
-
When a Custom Dimension is set for the user it will be persisted across sessions and app exit until:
- Another custom dimension value is specified.
- The dimension value is reset by calling with null.
- The app is re-installed.
-
Our event collection system allows up to 100 unique custom dimensions values for each custom dimension category. This is more than what the SDKs allow (20 values) to make sure any changes in the list of values and any publishing of new builds will not create issues.
If you need to track more than 20 values, it may be worth considering Custom Event Fields