Analytics
Available Integrations
With our analytics integrations, Maxwell clients can track activity in the Borrower Hub. Our platform raises activity events which can be captured via through one of the following services:
Google Analytics (GA)
Google Tag Manager (GTM)
Adobe Experience Platform Launch (Launch)
In this document we describe the events that we track and provide basic instructions how to configure the analytics platforms that we integrate with.
Maxwell Events
Following is a list of the analytics events that Maxwell tracks. Each event describes the data associated with it.
Application Start
Application Start
Fires whenever an anonymous application is created.
{
event: 'mortgagehippo-application-start',
mortgageHippoEvent: {
action: 'start',
category: 'application',
label: undefined,
value: undefined
}
}
Account Signup
Account Signup
Fires whenever a borrower attempts to signup in Auth0.
{
event: 'mortgagehippo-account-signup',
mortgageHippoEvent: {
action: 'signup',
category: 'account',
label: undefined,
value: undefined
}
}
Account Login
Account Login
Fires whenever a borrower attempts to login in Auth0.
{
event: 'mortgagehippo-account-login',
mortgageHippoEvent: {
action: 'login',
category: 'account',
label: undefined,
value: undefined
}
}
Task Start
Task Start
Fires whenever you click on a task for the first time. This event is always followed by a Task View
event.
{
event: 'mortgagehippo-tasks-start',
mortgageHippoEvent: {
action: 'start',
category: 'tasks',
label: TASK_KEY, // the blueprint task key as string
value: undefined,
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as number
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
}
}
Task View
Task View
Fires whenever the borrower views a task. This event will also fire whenever the borrower starts an application.
{
event: 'mortgagehippo-tasks-view',
mortgageHippoEvent: {
action: 'view',
category: 'tasks',
label: TASK_KEY, // the blueprint task key as string
value: undefined,
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as number
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
}
}
Task Complete
Task Complete
Fires whenever a task is completed.
{
event: 'mortgagehippo-tasks-complete',
mortgageHippoEvent: {
action: 'complete',
category: 'tasks',
label: TASK_KEY, // the blueprint task key as string
value: undefined,
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as number
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
}
}
Field Change
Field Change
Fires whenever an enumerable field changes. Works for fields that involve a discrete choice as opposed to a free-text entry. Specifically, it works for the MortgageHippo field types of BOOLEAN
, CHECKBOX
, CHOICE
, CONSTANT
, COUNTRY
, DURATION
, SELECT
, and USSTATE
.
{
event: 'mortgagehippo-answer-set',
mortgageHippoEvent: {
action: 'set',
category: 'answer',
label: FIELD_KEY, // the blueprint field key as string
value: NEW_VALUE, // if number, otherwise undefined
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as number
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
answerKey: FIELD_KEY, // the blueprint field key as string
answerValue: NEW_VALUE,
}
}
Pricing Option Selected
Pricing Option Selected
Fires when the user selects a pricing option in the Pricing Task.
{
event: 'mortgagehippo-pricing-set',
mortgageHippoEvent: {
action: 'set',
category: 'pricing',
label: TASK_KEY, // the blueprint task key as string
value: undefined,
productName: PRODUCT_NAME, // as string
apr: APR, // as number or undefined
rate: RATE, // as number or undefined
price: PRICE, // as number or undefined
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as undefined
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
}
}
Credit Scores Displayed
Credit Scores Displayed
Fires when the borrower’s credit report is complete and the scores are displayed to the borrower.
{
event: 'mortgagehippo-credit-show',
mortgageHippoEvent: {
action: 'show',
category: 'credit',
label: TASK_KEY, // the blueprint task key as string
value: undefined,
scores: [
{
transunion: TR_SCORE, // as number or undefined
equifax: EQ_SCORE, // as number or undefined
experian: EX_SCORE, // as number or undefined
}
],
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as undefined
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
}
}
Answer Push
Answer Push
Fires whenever a borrower adds an item to a field of type array
- this is a field that contains a list of items of the same kind, e.g. employers, dependents, assets, real estate owned, etc.
Currently this event is supported only for the Employers Task when the borrower manually adds an employer.
{
event: 'mortgagehippo-answer-push',
mortgageHippoEvent: {
action: 'push',
category: 'answer',
label: FIELD_LABEL, // the label of the changed field as string
value: undefined,
applicationFileId: APP_ID, // the unique id of the application as string
taskId: TASK_ID, // the unique task ID as undefined
taskKey: TASK_KEY, // the blueprint task key as string
taskTitle: TASK_TITLE // the task title as string
answerKey: FIELD_KEY, // the blueprint field key as string
answerValue: NEW_VALUE,
}
}
Google Analytics (GA) and Tag Manager (GTM)
About Google Analytics (GA)
GA allows you to track a more limited set of the event data that we provide (even if funneled via GTM). To track all event data that we provide, you can use Google Tag Manager.
GA can track only the following subset event data from the event mortgageHippoEvent
field:
{
action,
category,
label,
value
// all other data omitted
}
This is the same as calling the sendEvent
method of the GA API:
analytics.sendEvent('category', 'action', { label: 'event label', value: 1 })
Create a new account in Google Tag Manager. When you create it, a value will appear at the top left that starts with GTM-. This is the value you need to provide us after configuring everything in Google Tag Manager.
Create a new Google Analytics account. And configure a data stream. At the end of the data stream setup, a new modal will appear with "Web stream details". There, on the right side you will see the "MEASUREMENT ID". Copy that value as we will need it later.
Now, it's time to configure the variables, triggers and tags in Google Tag Manager.
Create an initial tag:
Tag
Tag Type
Google Tag
Tag ID
MEASUREMENT ID (G-XXXXXXXXXX)
Triggering
Initialization - All Pages
* Please note that the Tag ID requested here is the same Measurement ID
Create the following variables:
Variable
Name
Google Analytics Measurement ID
Variable Type
Constant
Value
MEASUREMENT ID (G-XXXXXXXXXX)
Variable
Name
MortgageHippo Event Action
Type
Data Layer Variable
Data Layer Variable Name
mortgagehippoEvent.action
Variable
Name
MortgageHippo Event Category
Type
Data Layer Variable
Data Layer Variable Name
mortgagehippoEvent.category
Variable
Name
MortgageHippo Event Label
Type
Data Layer Variable
Data Layer Variable Name
mortgagehippoEvent.label
Variable
Name
MortgageHippo Event Value
Type
Data Layer Variable
Data Layer Variable Name
mortgagehippoEvent.value
Create the following Triggers:
Trigger
Name
MortgageHippo Event
Type
Custom Event
Event Name
mortgagehippo\-.+
Use regex matching
checked
This triggers fires on
All Custom Events
Trigger
Name
History Change
Type
History Change
This triggers fires on
All History Changes
Create the following Tags:
Tag
Name
MortgageHippo Page View - GA1
Type
Google Analytics: Universal Analytics (Legacy)
Track Type
PageView
Google Analytics Settings
{{Google Analytics Measurement ID}}
Triggering
All Pages, History Change
Tag
Name
MortgageHippo Page View - GA Event
Type
Google Analytics: Universal Analytics (Legacy)
Track Type
Event
Category
{{MortgageHippo Event Category}}
Action
{{MortgageHippo Event Action}}
Label
{{MortgageHippo Event Label}}
Value
{{MortgageHippo Event Value}}
Non-Interaction Hit
False
Google Analytics Settings
{{Google Analytics Measurement ID}}
Triggering
MortgageHippo Event
Adobe Experience Platform Launch (Launch)
Once you complete your Launch setup, you will need to send us your Launch Embed Code, which will look similar to this:
<script src="https://assets.adobedtm.com/launch-ENa21cfed3f06f4ddf9690de8077b39e81-development.min.js" async></script>
Last updated