Analyze

Understand how your users are interacting with Argyle Link through analytics.

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

This provides a better understanding of users' behavior and allows you to troubleshoot and optimize 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) — Activates deep-linking. Can be true or false.

onUIEvent callback example:

1{
2    "name": "login - form submitted",
3    "properties": {
4        // Persistent:
5        "linkItem": "kroger",
6        "accountId": "e98d80cfecd94bbf96b11d58382b96ef",
7        "userId": "e98d80cfecd94bbf96b11d58382b96ef",
8        "deepLink": false,
9    }
10}

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):

onUIEvent callback example (with event-specific properties):

1{
2    "name": "error - opened",
3    "properties": {
4        // Persistent:
5        "linkItem": "croger",
6        "accountId": "e98d80cfecd94bbf96b11d58382b96ef",
7        "userId": "e98d80cfecd94bbf96b11d58382b96ef",
8        "deepLink": false,
9        // Event specific:
10        "errorType": "invalid_link_items"
11    }
12}

Intro screen#

Search screen#

• 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#

• errorCode (string) — The error code received while opening the Login screen. Possible values: see accounts.connection.error_code.
• errorMessage (string) — The error message received while opening the Login screen.

MFA screen#

• type (string) — Denotes whether the user was in the Login screen or Direct deposit opened screen when an MFA screen was shown to the user. Possible values: Login, PDF 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#

Account Status screen#

Direct deposit opened screen#

• allocationType (string) — Denotes which pay allocation type was shown when the user opened the Direct deposit settings screen. Possible values: percent, amount, none.

Allocation type selection screen#

Direct deposit success screen#

Account Error Screen#

• connectionStatus (string) — Represents the status of the link between Argyle and the work platform. Possible values: see accounts.connection.status.
• connectionErrorCode (string) — Provides information on why the connection failed when connection.status is error. Possible values: see accounts.connection.error_code.
• payDistributionStatus (string) — Denotes the point in the process of the direct deposit update. Possible values: see accounts.pay_distribution.status.
• payDistributionCode (string) — Provides information on why the direct deposit update was unsuccessful when pay_distribution.status is error. Possible values: see accounts.pay_distribution.error_code.

Error screen#

• errorType (string) — The type of error received while opening Link. Possible values: generic, invalid_link_items, invalid_pd_config, invalid_link_key, invalid_user_token.

Multiple screens#

The event below happens on several screens: