Link Analytics

Learn how to know what the users are doing within Argyle Link.

Overview

Through the onUIEvent callback function, it is possible to track what the users are doing within Argyle Link.

It provides a better understanding of the users' behavior and allows you to troubleshoot and optimize the conversion rates.

Persistent properties

The onUIEvent is invoked when specific events are activated. These events are passed with a data object with persistent properties as follows:

linkItem
string

Link Item ID.

accountId
string

Account ID.

userID
string

User ID.

deepLink
boolean

Denotes if deep Link is activated.

Possible values: true, false.

Event-specific properties

In addition to the persistent properties, events can have specific properties. Find below all the Link screens on which events can be triggered and their respective event-specific properties (if applicable):

Intro screen

Event NameEvent descriptionEvent specific properties
intro - openedThe user opened the Intro screen.N/A

Search screen

Event properties

Event NameEvent descriptionEvent specific properties
search - openedThe user opened the Search screen.N/A
search - term updatedThe user typed in the search term for a link item in the Search screen.term, tab
search - link item selectedThe user selected a link item in the Search screen.term, tab
term
string

The text entered in the search field.

tab
string

The tab that the user has opened when entering text in the search field. This is ignored for an empty term, so if a user deletes the search term, the event callback will not be started.

Possible values: All, Employer, Gig, Payroll.

Login screen

Event properties

Event NameEvent descriptionEvent specific properties
login - openedThe user opened the Login screen.errorCode, errorMessage
login - form submittedThe user submitted the Login form.N/A
login - reset password clickedThe user clicked the "Reset password" link.N/A
errorCode
string

The error code received while opening the Login screen.

Possible values: see connection.error_code.

errorMessage
string

The error message received while opening the Login screen.

MFA screen

Event properties

Event NameEvent descriptionEvent specific properties
mfa - openedThe user was presented with Multi-Factor Authentication (MFA).type, mfaType
type
string

Denotes whether the user was in the Login or PD Review screen when a multi-factor authentication (MFA) screen was shown to the user.

Possible values: Login, PD Review.

mfaType
string

Denotes the type of multi-factor authentication (MFA) method that was required of the user.

Possible values: sms_code, email_code, secret_question, email_link_confirmation, otp_code, email_message_conformation.

Success screen

Event properties

Event NameEvent descriptionEvent specific properties
success - openedThe user opened the Success screen after the account was successfully connected.N/A

Account Status screen

Event properties

Event NameEvent descriptionEvent specific properties
account status - openedThe user opened the Account Status screen.N/A
account status - disconnectedThe user disconnected their employment account.N/A

PD Review screen

Event properties

Event NameEvent descriptionEvent specific properties
pd review - openedThe user opened the PD Review screen.ShowEdit, defaultSplit, splits
showEdit
boolean

Denotes if the Edit button was shown.

Possible values: true, false.

defaultSplit
string

Denotes which pay allocation type was shown as the default one when the user opened the PD Review screen.

Possible values: percent, amount.

splits
string

Denotes which pay allocation type was available when the user opened the PD Review screen.

Possible values: percent, amount, both.

PD Edit screen

Event properties

Event NameEvent descriptionEvent specific properties
pd edit - openedThe user opened the PD Edit screen.allowAddBank, defaultSplit, splits
allowAddBank
boolean

Denotes if the Add bank account button was shown.

Possible values: true, false.

defaultSplit
string

Denotes which pay allocation type was shown as the default one when the user opened the PD Review screen.

Possible values: percent, amount.

splits
string

Denotes which pay allocation type was available when the user opened the PD Review screen.

Possible values: percent, amount, both.

PD Success screen

Event properties

Event NameEvent descriptionEvent specific properties
pd success - openedThe user opened the PD Success screen after pay distribution is successfully updated.N/A

Account Error screen

Event properties

Event NameEvent descriptionEvent specific properties
account error - openedThe user received an error while connecting an account.connectionStatus, connectionErrorCode, payDistributionStatus, payDistributionErrorCode
connectionStatus
string

Represents the status of the link between Argyle and the work platform.

Possible values: see connection.status.

connectionErrorCode
string

Provides information on why the connection failed when connection.status is error.

Possible values: see connection.error_code.

payDistributionStatus
string

Denotes the point in the process of the pay distribution update process.

Possible values: see pay_distribution.status.

payDistributionErrorCode
string

Provides information on why the pay distribution update was unsuccessful when pay_distribution.status is error.

Possible values: see pay_distribution.error_code.

Error screen

Event properties

Event NameEvent descriptionEvent specific properties
error - openedThe user received an error while opening Link.errorType
errorType
string

The type of error received while opening Link.

Possible values: expired_user_token,invalid_plugin_key, invalid_user_token,invalid_pd_config.

Multiple screens

The event below happens on several screens:

Event properties

Event NameEvent descriptionEvent specific properties
link closedUser closed Link.N/A