Skip to content

ANALYTICS.md

Latest commit

 

History

History
146 lines (122 loc) · 35.5 KB

ANALYTICS.md

File metadata and controls

146 lines (122 loc) · 35.5 KB

← Analytics

The connect widget provides a way to track events/pageviews and submit survey responses using your own analytics provider.

onAnalyticEvent

The onAnalyticEvent function is used to track events.

const onAnalyticEvent = (eventName: string, metadata: object) => {
  console.log('onAnalyticEvent', eventName, metadata)
}

Analytic Events

Analytic Events
Event Name Description Metadata
connect_create_credentials_clicked_forgot_password Triggers on the create credentials step when a user clicks the Forgot Password button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_create_credentials_clicked_forgot_username Triggers on the create credentials step when a user clicks the Forgot your username? button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_create_credentials_clicked_trouble_signing_in Triggers on the create credentials step whe a user clicks the Trouble signing in? button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_credentials_clicked_get_help Triggers on the update credentials step when a user clicks the Get help button 
{
  "type": string
}
connect_entered_login Triggers on the credentials step when a user clicks the username input 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_entered_password Triggers on the credentials step when a user clicks on the password input 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_submitted_credentials Triggered on the credentials step when a user submits their credentials 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_update_credentials_clicked_forgot_password Triggers on the update credentials step when a user clicks the Forgot Password button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_update_credentials_clicked_forgot_username Triggers on the update credentials step when a user clicks the Forgot your username? button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_update_credentials_clicked_trouble_signing_in Triggers on the update credentials step whe a user clicks the Trouble signing in? button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_login_error_clicked_get_help Triggered on the credentials step when there is a login error when a user clicks the Get help button. 
{}
connect_mfa_clicked_get_help Triggered on the MFA step when a user clicks the Get help button 
{}
connect_mfa_entered_input Triggered on the MFA step when a user clicks on the input 
{
  "institution_guid": string,
  "institution_name": string,
  "member_guid": string,
}
connect_mfa_submitted_input Triggered on the MFA step when a user submits their MFA answer 
{
  "institution_guid": string,
  "institution_name": string,
  "member_guid": string,
}
connect_mfa_selected_image Triggered on the MFA step when a user clicks on an image during the image MFA flow. 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_mfa_submitted_image Triggered on the image MFA step when a user submits their MFA answer 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_mfa_selected_option Triggered on the MFA step when multiple options are given and a user selects their option 
{
  "institution_guid": string,
  "institution_name": string,
  "selected_option": string,
  "member_guid": string,
}
connect_mfa_submitted_option Triggered on the MFA step when multiple options are given and a user submits their option 
{
  "institution_guid": string,
  "institution_name": string,
  "member_guid": string,
}
connect_no_eligible_accounts_retry Triggers on the no eligible accounts screen when a user clicks the Try again button 
{
  "authentication_method": string,
  "institution_guid": string,
  "institution_name": string,
}
connect_oauth_pending_member_created Triggered when an oauth member is created 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_oauth_default_cancel Triggered on the OAuth step when a user clicks the Cancel button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_oauth_default_go_to_institution Triggered on the OAuth step when a user clicks the Go to log in button 
{
  "institution_guid": string,
  "institution_name": string,
  "member_guid": string,
}
connect_waiting_for_oauth_cancel Triggered on the waiting OAuth step when a user clicks the Cancel button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_waiting_for_oauth_tryagain Triggered on the waiting OAuth step when a user clicks the Try again button 
{
  "institution_guid": string,
  "institution_name": string,
}
connect_search_query Triggered on the search step when a user is typing in their search term 
{
  "search_term": string,
}
connect_select_popular_institution Triggered on the search step when a user selects a popular institution 
{}
connect_select_searched_institution Triggered on the search step when a user selects from a searched institution 
{
  "authentication_method": string,
  "institution_guid": string,
  "institution_name": string,
}
connect_widget_load Triggered when the widget is loaded 
{
  "widget_type": string,
  "initial_step": string,
  "mode": string,
  "disable_institution_search": boolean,
  "include_identity": boolean,
  "include_transactions": boolean,
  "current_member_guid": string,
  "current_institution_guid": string,
  "current_institution_code": number,
}

onAnalyticPageview

The onAnalyticPageview function is used to track pageviews.

const onAnalyticPageview = (path: string, metadata: object) => {
  console.log('onAnalyticPageview', path, metadata)
}

Analytic Pageviews

Pageviews
Pageview Description Metadata
Connect Triggered by connect loaded, will show up in the path as /connect 
{}
Connect Successful Triggered on the connected step, will have /connected in the path 
{
  "authentication_method": string
}
Connect Connecting Triggered on the connecting step, will have /connecting in the path 
{
  "authentication_method": string
}
Connect Create Credentials Triggered on the credentials step, will have /credentials/create_credentials_form in the path 
{
  "institution_guid": string,
  "institution_name": string 
}
Connect Delete Member Success Triggered on the member delete success step, will have /delete_member/success in the path 
{}
Connect Delete Member Survey Triggered on the member delete survey step, will have /delete_member/survey in the path 
{}
Connect Disclosure Triggered on the disclosure step (either the footer or the first step), will have /disclosure in the path 
{}
Connect Disclosure Data Available Triggered on the data available disclosure step, will have /data_available in the path 
{}
Connect Disclosure Data Requested Triggered on the data requested disclosure step, will have /data_requested in the path 
{}
Connect Disclosure Privacy Policy Triggered on the privacy policy step of disclosure, will have /privacy_policy in the path 
{}
Connect Generic Error Triggered on the generic error step, will have /generic_error in the path 
{
  "error_message": string,
  "error_status": string,
  "resource": string, 
}
Connect IE 11 Deprecation Triggered if a user is using IE 11, will have /ie_11_deprecation in the path 
{}
Connect Login Error Triggered if there is a login error, will have /login_error in the path 
{}
Manual Account Connect Triggered when the manual account flow is entered, will have /manual_account_connect in the path 
{}
Connect Manual Account Form Triggered when a user selects what kind of manual account they are adding, will have /manual_account_form in the path 
{}
Connect Manual Account Success Triggered when a user successfully adds a manual account, will have /manual_account_success in the path 
{}
Connect MFA Default Triggered when a user enters the MFA Flow, will have /mfa_default in the path 
{}
Connect MFA Image Options Triggered when the user enters the MFA flow and the questions are to select images, will have /mfa_image_options in the path 
{}
Connect MFA Options Triggered when the user enters the MFA flow and the question is to select an option, will have /mfa_options in the path 
{}
Connect MFA Single Account Select Triggered in verification mode when single account select is true and a user selects a credential based institution, will have /single_account_select in the path 
{}
Connect Microdeposits Triggered in verification mode when a user enters the microdeposit flow, will have /microdeposits in the path 
{}
Connect Microdeposits Account Info Triggered in verification mode in the microdeposit flow when a user is on the account information page, will have /account_info in the path 
{}
Connect Microdeposists Come Back Triggered in verification mode when a user is finished with the microdeposit flow, will have /come_back in the path 
{}
Connect Microdeposits Confirm Details Triggered in verification mode when a user is finished inputing all their details for the microdeposit, will have /confirm_details in the path 
{}
Connect Microdeposits How It Works Triggered in verification mode at the start of the microdeposit flow, will have /how_it_works in the path 
{}
Connect Microdepoits Microdeposit Errors Triggered in verification mode at the end of the microdeposit flow if there are any errors, will have /microdeposit_errors in the path 
{}
Connect Microdeposits Personal Info Form Triggered in verification mode during the microdeposit flow when the user enters the personal information (first name, last name, email address) flow, will have /personal_info_form in the path 
{}
Connect Microdeposits Routing Number Triggered in verification mode during the microdeposit flow when the user enters the routing number step, will have /routing_number in the path 
{}
Connect Microdeposits Verified Triggered in verification mode when the user correctly inputs the result of the microdeposit, will have /verified in the path 
{}
Connect Microdeposits Verifying Triggered in verification mode when the user inputs the result of the microdeposit and it is being verified, will have /verifying in the path 
{}
Connect Microdeposits Verify Deposits Triggered in verification mode on the verify deposits page when the user comes back to verify their microdeposit, will have /verify_deposits in the path 
{}
Connect Not Found Error Triggered when there is a 404 error, will have /not_found_error in the path 
{}
Connect Oauth Step Instructions Triggered when the user enters the OAuth flow, will have /credentials/oauth_step/instructions in the path 
{
  "institution_guid": string,
  "institution_name": string 
}
Connect Oauth Step Waiting Triggered on the OAuth step when the user is taken to their instituiton to input their credenitals, will have /credentials/oauth_step/waiting in the path 
{
  "institution_guid": string,
  "institution_name": string 
}
Connect Oauth Error Triggered on the OAuth step if there was an error during the flow, will have /oauth_error in the path 
{}
Connect No Eligible Accounts Triggered in verification mode if the user selected an institution where they have no DDA accounts, will have /no_eligible_accounts in the path 
{}
Connect Search Triggered when the user enters the search step , will have /search in the path 
{}
Connect Search Failed Triggered on the search step and search is not receiving any information from the backend , will have /search_failed in the path 
{}
Connect Search No Results Triggered on the search step and there are no results for what was searched , will have /no_results in the path 
{
  "search_term": string,
}
Connect Search Popular Triggered on the search step before the user has searched for anything and search is displaying the popular institutions, will have /popular in the path 
{}
Connect Searched Triggered on the search step after a user has typed in a search term, will have /searched in the path 
{}
Connect Shared Routing Number Triggered in verification mode during the microdeposit flow when a user enters a routing number of an institution that supports instant verification, will have /shared_routing_number in the path 
{}
Connect Support Menu Triggered when a user enters the support flow, will have /support/support_menu in the path 
{}
Connect Support Request Institution Triggered when a user enters the support flow and goes to the request institution page, will have /support/request_institution in the path 
{}
Connect Support General Triggered when a user enters the support flow and goes to the general support page, will have /support/support_general in the path 
{}
Connect Support Success Triggered when a user enters the support flow and successfully submits a support ticket, will have /support/support_success in the path 
{}
Connect Update Credentials Triggered on the credentials step when a user updates their credentials, will have /credentials/update_credentials_form in the path 
{}
Connect Unsupported Resolution Triggered when a user is using a device that has a width smaller than 320 px, will have /unsupported_resolution in the path 
{}
Connect Verify Existing Member Triggered in verification mode if the user has previously connected institutions, will have /verify_existing_member in the path 
{}

onSubmitConnectSuccessSurvey

The onSubmitConnectSuccessSurvey function is used to submit connect success survey responses using your own analytics provider.

const onSubmitConnectSuccessSurvey = (answers: object) => {
  console.log('onSubmitConnectSuccessSurvey', answers)
}

onShowConnectSuccessSurvey

The onShowConnectSuccessSurvey function is used to let your analytics provider know that the connect success survey was shown.

const onShowConnectSuccessSurvey = () => {
  console.log('onShowConnectSuccessSurvey')
}

<-- Back to README