Link analytics and tracking

Actions a user can take within the Link flow are instrumented, allowing you to understand and measure a user's activity in Link. Plaid provides pre-packaged summary views of some of the most important analytics within the Dashboard. For more advanced analysis, you can obtain and track Link activity on your own. This can be done either by tracking user activity on the frontend via the onSuccess, onEvent, and onExit callbacks, or via the backend, using the /link/token/get endpoint.

Link events are also tracked in the Dashboard via the Developer Logs. However, the Developer Logs are designed for troubleshooting and not recommended for analytics use cases, as they cannot easily be exported to a third-party analytics platform.

This guide will go over the most important fields and events used for analytics, as well as the most popular analytics use cases. For a complete view of all user activity reporting that can be obtained from Link, see the documentation for the specific frontend platform SDK you are using (if tracking activity on the frontend) or for /link/token/get (if tracking activity on the backend).

The onExit callback is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. If the user encountered an error in the Link flow, the error object will obtain details of the most recently encountered error, including the error.error_code, error.error_type, and human-readable error.error_message.

1{
2  error_type: 'ITEM_ERROR',
3  error_code: 'INVALID_CREDENTIALS',
4  error_message: 'the credentials were not correct',
5  display_message: 'The credentials were not correct.',
6}

The Link Analytics page in the Plaid Dashboard will show the five most common errors reported during the Link flow for your integration.

The onExit callback is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. The metadata.status field within onExit field will reflect the point of the Link flow where the user abandoned the flow, and the metadata.institution field will reflect which institution the user was attempting to connect to.

1{
2  institution: {
3    name: 'Citizens Bank',
4    institution_id: 'ins_20'
5  },
6  status: 'requires_credentials',
7  link_session_id: '36e201e0-2280-46f0-a6ee-6d417b450438',
8  request_id: '8C7jNbDScC24THu'
9}

For almost every action your user takes within the Link flow, the onEvent callback will fire, allowing you to track their progress through Link. The eventName provided within onEvent typically corresponds to an action the user has taken in Link or an outcome that has occurred.

The most important event names include OPEN (the user has opened Link), TRANSITION_VIEW (the user has progressed to a new pane in Link), HANDOFF (the user has successfully completed Link), ERROR (a recoverable error has occurred in Link), and EXIT (the user has closed Link without completing it).

The event names you should track will depend on your use case and the Plaid products you use. For a complete listing of event names, see the reference documentation for your SDK (or /link/token/get).

1OPEN
2TRANSITION_VIEW
3SELECT_INSTITUTION
4TRANSITION_VIEW
5SUBMIT_CREDENTIALS
6TRANSITION_VIEW
7HANDOFF

1OPEN
2TRANSITION_VIEW
3SELECT_INSTITUTION
4TRANSITION_VIEW
5SUBMIT_CREDENTIALS
6TRANSITION_VIEW
7ERROR
8TRANSITION_VIEW
9SUBMIT_CREDENTIALS
10TRANSITION_VIEW
11ERROR
12TRANSITION_VIEW
13EXIT

For a more granular view of a user's experience in Link, you can also record the metadata.viewName within onEvent. While the eventName typically reflects the action taken by the user or the result of their action, the viewName reflects the name of the specific Link pane being shown to the user, such as ACCEPT_TOS (asking the user to consent to the Plaid Terms of Service) or OAUTH (informing the user that they will be handed off to their institution's OAuth flow).

You can view your Link conversion by viewing the Link > Analytics page in the Plaid Dashboard, or by setting up your own conversion tracking. Tracking conversion on your own is recommended if you want more detailed analytics than reported in the Dashboard (for example, to perform A/B testing on Link conversion) or to connect Link conversion to your company's analytics platform.

For tracking conversion, the most important events are HANDOFF, which indicates that the user has linked an Item, and EXIT, which indicates that the user has exited without linking an account.

Your overall conversion rate is measured as the number of HANDOFF events divided by the number of unique link_session_ids. Alternatively, you can divide by the sum total of HANDOFF and EXIT events, but this method is less accurate, since an EXIT event will not fire if a user destroys Link by quitting the browser or closing the tab. You can obtain insight into at what point a user abandoned Link by tracking the metadata.status field within onExit.

1...
2SELECT_INSTITUTION
3TRANSITION_VIEW (view_name = OAUTH)
4OPEN_OAUTH
5TRANSITION_VIEW (view_name = CONNECTED)
6HANDOFF

1...
2SELECT_INSTITUTION
3TRANSITION_VIEW (view_name = CREDENTIAL)
4SUBMIT_CREDENTIALS
5TRANSITION_VIEW (view_name = MFA, mfa_type = code)
6SUBMIT_MFA (mfa_type = code)
7TRANSITION_VIEW (view_name = CONNECTED)
8HANDOFF

You can also capture the institution_name field, provided by the onEvent callback, to track which institutions your users are attempting to connect to.

Many customers use third-party analytics platforms to analyze conversion data, which can allow you to easily view data by platform or institution. Lower conversion on a specific platform or institution may indicate an implementation problem. For example, lower conversion on mobile for OAuth-supporting institutions may indicate an issue with the handling of OAuth redirects or failure to implement app-to-app.

We recommend tracking conversion data over time to measure the impact of changes to your Link integration.

Once you're measuring Link conversion, make sure you're maximizing it. For tips, see Optimizing Link conversion.