Capture event and session properties for mobile frontends

  • Latest Dynatrace
  • How-to guide

Event and session properties let you attach custom-defined key-value pairs to user events and user sessions, using the namespaces event_properties and session_properties.

Before you start sending event or session properties

Event and session properties must be configured before they can be used. Incoming event and session properties that are not configured are dropped during event ingest.

To define a new property

  1. In Experience Vitals Experience Vitals, select the frontend for which you want to add the property.
  2. Select the Settings tab, then choose Event and session properties.
  3. Select Add under either Defined event properties or Defined session properties, depending on the type of property you want to create.
  4. In the Field name box, enter a name for your property (for example, cart.total_value).
  5. Optional To make the field name case-insensitive, turn on Field name validation should be case-insensitive.
  6. From the Datatype list, select the appropriate data type for your property: string, boolean, or number.

Dynatrace automatically prefixes your field name with event_properties. or session_properties. based on the property type you selected. For example, a field name of cart.total_value will become event_properties.cart.total_value.

How to send properties

Event and session properties can be sent via the New RUM APIs:

Limits

  • Naming
    • Field name maximum length: 100 characters (including the event_properties. / session_properties. prefix).
    • Allowed characters in field name: A–Z, a–z, 0–9, underscore _, and dot ..
    • Each dot must be followed by an alphabetic character.
    • Each underscore must be followed by an alphabetic character or number.
  • Counts—a maximum of 20 event and session properties can be configured.
  • Values
    • Values must be primitive types (String, Int, Long, Double, Boolean).
    • For event and session properties of data type String, the length is limited to 1,000 characters.

Valid examples:

  • event_properties.purchase_state
  • event_properties.cart.total_value
  • session_properties.product_tier
  • session_properties.loyalty_status
Related tags
Digital Experience