Analytics

Capture how users interact with Link.

Overview#

You can track user behavior in Link by including the onUIEvent callback in your Link initialization.

The onUIEvent callback is triggered for specific UI events in Link, and although optional, including this callback can help with troubleshooting as well as optimizing conversion rates.

Callback format#

Add the line below to your Link initialization:

1onUIEvent: (payload) => console.log('onUIEvent', payload);

Callback payload#

The onUIEvent callback returns:

  1. The name of the UI-related Event that triggered the callback.
  2. A properties object, which can include:
    • deepLink (always) β€” Whether the user was directly connected to the Item.
    • itemId (conditional) β€” ID of the relevant Item.
    • accountId (conditional) β€” ID of the user's account.
    • Event-specific properties (conditional) β€” See Events below.

Example:

1UIEvent (
2    "name": "mfa - opened",
3    "properties": {
4        "deepLink": false,
5        "itemId": "item_123456789",
6        "type": "Login",
7        "mfaType": "sms_code"
8    }
9)

Events#

Intro screen#

Event NameEvent DescriptionEvent Specific Properties
intro - openedThe user opened the intro screen.none

Search screen#

Event NameEvent DescriptionEvent Specific Properties
search - openedThe user opened the search screen.none
search - term updatedThe user entered a search term.term, tab
search - link item selectedThe user selected an Item from the search screen.term, tab

Property definitions:

  • term β€” The text entered in the search field.
  • tab β€” The tab that was open when the user entered a search term or selected an Item. Ignored for empty (or deleted) search terms. Possible values: Popular, Payroll providers, Employers

Login screen#

Event NameEvent DescriptionEvent Specific Properties
login - openedThe user opened the login screen.errorCode, errorMessage
login - form submittedThe user submitted login credentials.none
login - login help clickedThe user selected "Login help".none

Property definitions:

  • errorCode β€” The account connection error relevant to the login screen that occurred. Possible values: auth_required, expired_credentials, invalid_auth, invalid_credentials, invalid_login_method, mfa_timeout
  • errorMessage β€” The account connection error message shown to the user.

MFA screen#

Event NameEvent DescriptionEvent Specific Properties
mfa - openedThe user was routed through a multi-factor authentication (MFA) process.type, mfaType

Property definitions:

  • type β€” Whether MFA occurred during login or a deposit switch. Possible value: Login, DDS
  • mfaType β€” The type of MFA. Possible values: sms_code, email_code, secret_question, email_link_confirmation, otp_code, email_message_confirmation

Success screen#

Event NameEvent DescriptionEvent Specific Properties
success - openedThe user entered the success screen after a successful account connection.none

Account status screen#

Event NameEvent DescriptionEvent Specific Properties
account status - openedThe user opened the account status screen.none
account status - disconnectedThe user revoked access to an account.none

Direct deposit opened screen#

Event NameEvent DescriptionEvent Specific Properties
dds settings - openedThe user opened the direct deposit settings screen.allocationType

Property definitions:

  • allocationType β€” Which type of pay allocation was shown to the user. Possible values: percent, amount, none

Allocation type selection screen#

Event NameEvent DescriptionEvent Specific Properties
allocation type selection - openedThe user opened the allocation type selection screen.none

Direct deposit success screen#

Event NameEvent DescriptionEvent Specific Properties
dds success - openedThe user entered the success screen after a successful deposit switch.none

Account error screen#

Event NameEvent DescriptionEvent Specific Properties
account error - openedThe user encountered an error while connecting an account.connectionStatus, connectionErrorCode, ddsStatus, ddsErrorCode

Property definitions:


Event NameEvent DescriptionEvent Specific Properties
error - openedThe user encountered an error while opening Link.errorType

Property definitions:


Occurs when the user closes Link from any screen.

Event NameEvent DescriptionEvent Specific Properties
link closedThe user closed Link.none
Updating Argyle status...
Β© 2023 Argyle Systems Inc.argyle.com