User Value Attribution
Prerequisite: Complete the SDK Integration Guide first
- This guide requires you to have already integrated the Branch SDK into your app.
In-app engagement and user value metrics are just as important as the click, install, and re-open metrics that Branch automatically provides. You can define your own post-install events for Branch to track, and view them in the dashboard.
In addition the default Branch events, you can track any custom user action you wish. Recording a custom event in your app is accomplished via a simple call to the SDK as shown in the examples below.
We’ve also defined a set of pre-defined events that we believe to be commonly used:
|BNCRegisterViewEvent||User viewed the object|
|BNCAddToWishlistEvent||User added the object to their wishlist|
|BNCAddToCartEvent||User added object to cart|
|BNCPurchaseInitiatedEvent||User started to check out|
|BNCPurchasedEvent||User purchased the item|
|BNCShareInitiatedEvent||User started to share the object|
|BNCShareCompletedEvent||User completed a share|
Caution: Names reserved for Branch events
open_assistare reserved for Branch events, and these are filtered out of custom events in the dashboard. Please choose distinct names for your custom events.
Let’s say you want to track an event where user adds multiple items to their cart, letting Branch know which of those objects were added. Or register a view on multiple objects at once. You’d use the state dictionary to pass us those items as shown in the below examples.
Additionally, you’re going to want to use these constants for the custom metadata.
|BNCCanonicalIdList||The key for the array of canonical identifiers|
|BNCPurchaseAmount||The key to define the checkout price if applicable|
|BNCPurchaseCurrency||The key to define the currency of the purchase amount if applicable|
Custom events columns on these pages show total events count and events %, where the percentage is total events over total Branch-referred app sessions (installs + re-opens). You can see these metrics for individual links, campaigns, channels, tags, stages, and features.
There’s no hard limit to tracking custom events data, but Branch will only allow you to see your first 100 custom events in the Branch dashboard. Most apps track 5-10 of the most important custom events they care about.
What attribution logic does Branch use for reporting on custom events in the dashboard?
90-day attribution window: Branch will include counts of events that happen within 90 days of a user’s most recent Branch-referred session.
Last-session attribution: We’ll attribute a custom event to the link click and resulting Branch-referred session that occurs most recently prior to a custom event.
Events are reported on the date the attributed Branch-referred session occurred, not the date the the actual event occurred: In the following sequence of events, Branch will report on the event on Feb 1, although the event itself happened on Feb 3:
- Feb 1: User clicks on a Branch link and installs app
- Feb 3: User returns to app (not via Branch link) and completes an in-app custom event
For more information on how Branch attributes custom events, see this FAQ.
You can also see custom events as they occur on the Live View > Events page.