Tracking Plaid Link analytics

This article offers suggestions on how to utilize onEvent callbacks to track user behavior within Plaid Link. 

The onEvent callback is called throughout multiple points within the Plaid Link flow. This callback has an eventName parameter, which describes the event that occurred within Plaid Link, and a metadata parameter, which includes additional details for each event. 

The key events to track for analysis purposes are the OPEN, TRANSITION_VIEW, ERROR, EXIT, and HANDOFF events. 

• OPEN: the onEvent callback will be fired with the OPEN event when your user first launches Plaid Link. Tracking this event will allow you to capture how many of your users opt-in to the Plaid Link flow. 
• TRANSITION_VIEW: the TRANSITION_VIEW event occurs when your user transitions from one pane in Plaid Link to the next. The metadata object associated with the TRANSITION_VIEW event provides details on the exact pane your user has transitioned to in the view_name field. For example, if your user just moved to the credentials pane after selecting their institution, the metadata object would return CREDENTIALS in the view_name field.  
• EXIT: the EXIT event occurs when your user exits from Plaid Link without successfully completing the flow. 
• ERROR: the ERROR event occurs when your user runs into a recoverable error within Plaid Link. The metadata object will provide details on the specific error your user encountered.
• HANDOFF: the HANDOFF event occurs when your user successfully links their account by completing the Plaid Link flow.

Additionally, please refer to the metadata reference to see all of the fields that can be utilized for your analytics.

Depending on what metrics are most valuable to your business, you can utilize the above events to analyze user behavior within Plaid Link. For example, many customers will track the OPEN to HANDOFF rate to understand how many users successfully link their account after entering Plaid Link. If you have any additional questions, please ask your account manager so that we can aid you with each step of the Plaid Link flow to ensure you are gathering the right analytics for your business.