The Branch Query Analytics API offers events data unavailable in Funnel's Branch connector. If your use case requires these events in Funnel, you can request them as a custom connector.
Custom connectors and data requests are available only in Business and Enterprise plans.
Metrics
All metrics can be pulled with the following aggregations (unique count, total count, revenue, cost). Due to the API, unique metrics can only be pulled at a maximum 7 day rolling window. To learn more about unique metrics from Branch, see: Comparing Unique Branch Data in Funnel.
Impression: Loading of a user generated and placed impression pixel for the purpose of creating an attributing event from a marketing effort. By this definition, no automated renders from Branch (for example, Journeys, Deepviews) are impressions, nor are views of content in the app.
Click: A user initiated action of tapping on a Branch link or html element directly in front of a Branch link.
Open: A mobile app launch that is not an install (that is, not a first time app launch for that persona). An open ends when an app is backgrounded or closed.
Install: The first time an app launches for a given IDFA/AAID. (Excludes cases where the IDFA is reset with the app still installed.)
Reinstall: When an app is deleted then re-installed on the same device (same device is defined as same IDFA/AAID).
Web Session Start: A website launch (that is, first page view). A session is considered to end after 30 minutes of inactivity (that is, not launching a page or triggering an event).
Pageview: A pageview is the loading of a single page for a given website which is triggered more specifically, by calling branch.init() or branch.track('pageview').
Commerce Event: A standard event where a customer is on a journey to pay money to a business. It excludes views, but includes adding to cart through to purchasing. Revenue is attached to this topic based on cost and event metadata.
Content Event: A standard event involving content that may or may not be a product, but excludes events where a customer is on a journey to pay money to a business (adding to cart to purchasing).
Custom Event: Custom event is a non-standard user tracked event.
User Lifecycle Event: A standard event not involving content.
Custom Events
Custom events are any events you choose to track with Branch that fall outside our list of standard events.
User Lifecycle Events
User lifecycle events are events marking a distinct action completed by a user as they progress through your app, such as COMPLETE_REGISTRATION.
Complete Registration
Complete Tutorial
Achieve Level
Unlock Achievement
Invite
Login
Start Trial
Subscribe
Content Events
Content events include a short list of events such as VIEW_ITEM that involve content and are not directly related to e-commerce.
Search
View Item
View Items
Rate
Share
Initiate Stream
Complete Stream
Commerce Events
Commerce events include purchases and transactions, as well as actions related to carts and wishlists.
Add to Cart
Add to Wishlist
View Cart
Initiate Purchase
Add Payment Info
Click Ad
Purchase
Reserve
Spend Credits
View Ad
Dimensions
Attributed: whether the event is attributed. will always be accompanied by last_attributed_touch_type and last_attributed_touch_data. set automatically server side.
Customer Event Alias: TUNE customers can specify that an event of type purchase should have name buy20tokens. customer_event_alias captures this name, which is additional information. For most events this is likely unnecessary. Exposed in Webhooks and Exports for TUNE customers only.
Days From Install To Opt In: number of days between when the first install (user_data_opted_in= false) and when this event occurred.
Days From Last Attributed Touch To Event: number of days between when the last touch occurred and when this event subsequently occurred. set automatically server side.
Deep Linked: true if the current app or web session resulted in the user being deep linked. set automatically server side.
Di Match Click Token: Branch Flow ID. Should be internal only, but used by Tune, Appsflyer and other to match a click to an install, using the Android install referrer. set server side, relayed by the client.
Event Data Ad Type: Ad type that the user saw or clicked on. Defined by Facebook. specified by the client.
Event Data Affiliation: Store or affiliation from which this transaction occurred (for example, Google Store). specified by the client.
Event Data Coupon: Transaction coupon redeemed with the transaction (for example, SPRING2017). specified by the client.
Event Data Currency: Currency that revenue, price, shipping, tax were originally reported in by the partner. specified by the client.
Event Data Description: Description associated with the event, not necessarily specific to any individual content items. specified by the client.
Event Data Exchange Rate: exchange rate from the time the event occurred (may be up to 24 hours old but is typically updated within the hour). specified by the client.
Event Data Revenue: partner-specified revenue for the event. specified by the client.
Event Data Search Query: Search query associated with the event. specified by the client.
Event Data Shipping: Shipping cost associated with the transaction. specified by the client.
Event Data Tax: Total tax associated with the transaction. specified by the client.
Event Data Transaction Id: partner-specified transaction id for their internal use. specified by the client.
Event Timestamp: unix timestamp in milliseconds of when the event actually happened.
Existing User: this is TUNE's existing_user flag. Pass-through field. specified by the client.
First Event For User: if this is the first time for this persona that this event has been triggered. set automatically server side.
Hours From Last Attributed Touch To Event: number of hours between when the last touch occurred and when this event subsequently occurred. CAPPED AT 24. set automatically server side.
Id: a unique id for the event. set automatically server side.
Install Activity Timestamp: An epoch timestamp for the time of the install in UTC in milliseconds.
Match Guaranteed: indicates if the match was made with 100% accuracy through deterministic methods.
Minutes From Last Attributed Touch To Event: number of minutes between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60. set automatically server side.
Name: the name of the event, such as CLICK, INSTALL, PURCHASE, or custom event names like signup. set either by the client (for example, custom events) or automatically server side.
Organization Id: the id of the organization for which the event occurred. set automatically server side.
Organization Name: the name of the organization for which the event occurred. set automatically server side.
Origin: whether the event originated with a Branch SDK/API call, or was sent by Segment or mParticle. set automatically server side.
Seconds From Last Attributed Touch To Event: number of seconds between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60. set automatically server side.
Timestamp: unix timestamp in milliseconds for the event. set automatically server side.
How to request this data
To request Branch Query Analytics data and other data that has not been covered here, submit a data request.