Skip to main content

User Personas

The MetadataHandler provides an extension for managing User Personas. User Personas allow you to dynamically segment app users and their sessions according to their behavior, characteristics, or other criteria that you create. This feature helps with analyzing user segments, understanding variations or poor performance in user behavior, and tailoring the application experience to meet the diverse of ways that users use your application.

Interface​

Retrieving Current User Personas​

To retrieve the current set of persona tags, use the currentPersonas property. This property fetches persona tags from the storage that apply to the user at the current point in time.

let personas = Embrace.client?.metadata.currentPersonas

Adding User Personas in the Embrace SDK​

User Personas in the Embrace SDK allow you to tag sessions with specific user traits or behaviors. This can help you prioritize fixing bugs that affect certain user segments.

There is are pre-defined tags that we think are useful, and you can feel free to add your own. Here are some examples on how to add user personas:

try? Embrace.client?.metadata.add(persona: PersonaTag.mvp, lifespan: .permanent)

try? Embrace.client?.metadata.add(persona: "completed_purchase", lifespan: .session)

It's recommended to extend PersonaTag when you define your own persona tags. This is a good practice to make sure these values stay consistent wherever they are used.

extension PersonaTag {
  static let authenticated: PersonaTag = "authenticated"

  static func bucket(name: StaticString) -> PersonaTag {
    return PersonaTag("bucket_\(name)")
  }
}

Overview of the Metadata Lifespan​

When you add Embrace metadata, you can apply a lifespan to that value. Sometimes it can be very useful to let contextual data "auto-expire" when no longer relevant, and at other times you want that data to exist for the user's entire time in your app.

There are three metadata lifespans:

  1. Session: Metadata with a session lifespan is tied to a single user session. When the session ends, this metadata is automatically cleared. This option is ideal for temporary states or conditions that are only relevant to a specific interaction period. For instance, if a user completes a purchase, it can be useful to mark the session with a persona to mark the "completed_purchase" in order to identify behaviors across users that led to that purchase.

  2. Process: A process lifespan is scoped to the lifetime of the application process. If the application restarts, process lifespan metadata will no longer apply. This can be useful for conditions that should persist across sessions but not continue into the next cold start of the application. An example of this could be a "first_launch" persona to mark any sessions that occur when the user first installs the app.

  3. Permanent: Metadata marked as permanent remains associated with the user across multiple sessions until explicitly removed. This is useful for long-term attributes, such as user roles or subscription statuses, that affect the user experience over time. You may want to use a "vip" persona to mark users that you'd like to make sure have a seamless experience. This could be your company's CEO so that you recognize the issues that somehow only ever seems to occur to them. Maybe you'll have a fix before you get that pesky email...

Conclusion​

User Personas provide a flexible way to tag and categorize user sessions for better analysis and personalization. By leveraging this functionality, developers can gain insights into user behavior and improve the application experience based on user segments.