DEVELOPER GUIDE
WhiteLabel Web Tracking

Web Tracking Events

7min

Event structs

Property

Description

eventName

Event name

payload

Payload, The payload structure may vary depending on the event name

All Web events name

Event Name

Payload

Description

app_loaded



The app loaded

page_view



Page exposure

page_duration



page duration

landing_continue_click



Click the continue button on the landing page

landing_exit_click



Click the exit button on the landing page

landing_terms_click



Click the terms link on the landing page

landing_privacy_policy_click



Click the privacy policy link on the landing page

institution_list_back_click



Click the back button on the institution list page

institution_list_exit_click



Click the exit button on the institution list page

institution_list_citizen_portal_click



Click the citizen portal button on the institution list page

institution_list_search

key

Search for institutions on the institution list page

institution_click

institutionCode

institutionName

Click to select an institution on the institution list page

data_confirmation_back_click

institutionCode

institutionName

Click the back button on the data confirmation page

data_confirmation_exit_click



Click the exit button on the data confirmation page

data_confirmation_continue_click

institutionCode

institutionName

Click the continue button on the data confirmation page

data_confirmation_validity_click

institutionCode

institutionName

Click the validity link on the data confirmation page

data_confirmation_klavi_portal_click

institutionCode

institutionName

Click the klavi link on the data confirmation page

authorise_success

institutionCode

institutionName

institutionType

Authorise success

authorise_success_connect_more_click

institutionCode

institutionName

Click the connect more account button on the authorise success page

authorise_success_finish_click

institutionCode

institutionName

Click the finish button on the authorise success page

authorise_fail

institutionCode

institutionName

institutionType

Authorise error

authorise_fail_retry_click

institutionCode

institutionName

Click the try again button on the authorise error page

authorise_fail_connect_another_click

institutionCode

institutionName

Click the connect another account button on the authorise error page

authorise_fail_exit_click

institutionCode

institutionName

Click the exit button on the authorise error page

unavailable_connect_another_click

institutionCode

institutionName

Click the connect another account button on the unavailable page

unavailable_cancel_click

institutionCode

institutionName

Click the exit button on the unavailable page

credentials_back_click

institutionCode

institutionName

Click the back button on the credentials page

consent_limit_connect_another_click

institutionCode

institutionName

Click the connect another account button on the consent limit reached page

consent_limit_exit_click

institutionCode

institutionName

Click the exit button on the consent limit reached page

credentials_exit_click



Click the back exit button on the credentials page

credentials_connect_click

institutionCode

institutionName

Click the connect button on the credentials page

mfa_show

institutionCode

institutionName

mfaId

mfaType

Show the MFA popup

mfa_ok_click

institutionCode

institutionName

mfaId

mfaType

Click the ok button on the MFA popup

mfa_cancel_click

institutionCode

institutionName

mfaId

mfaType

Click the cancel button on the MFA popup

Some common properties of payload

Property

Description

eventId

The event id

eventTime

The event time

linkId

Link identify

partnerAppId

The partner applicaton identify

partnerCode

The partner code

partnerName

The partner name

institutionCode

The institution code

institutionName

The institution name

key

Filter keywords for institution_list_search event

mfaId

The mfaId for events mfa_show , mfa_ok_click , mfa_cancel_click

mfaType

The mfaType for events mfa_show , mfa_ok_click , mfa_cancel_click

Example:

JSON


Event example

page_view event

When the page is accessed, the page_view event will be triggered.

JSON


page_view properties of payload

Property

Description

name

The name of the page. Optional values are landingPage institutionList dataConfirmation redirection success fail unavailable consentLimitReached credentials loading

url

The url address of the current page

path

The path of the current page

width

The viewable width of end user access device

height

The viewable height of end user access device



page_duration event

The page_duration event record how long users stay on the current page.

page_duration properties of payload

Property

Description

name

The page name

durationTime

The page duration time, value in milliseconds

loading_continue_click event

Click the Continue button on the data confirmation page to trigger the landing_continue_click event.

JSON


institution_click event

Select an institution in the institution list to trigger the institution_clickevent.

JSON


authorise_success event

User authorization successfully triggers authorise_success event

JSON


authorise_error event

User authorization successfully triggers authorise_error event

JSON