Analytics
With our analytics integrations, Revvin clients can track activity in the Borrower Hub. Our platform raises activity events which can be captured via through one of the following services:
- 1.Google Analytics (GA)
- 2.Google Tag Manager (GTM)
- 3.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.
Following is a list of the analytics events that MortgageHippo tracks. Each event describes the data associated with it.
Fires whenever an anonymous application is created.
Event Dts
{
event: 'mortgagehippo-application-start',
mortgageHippoEvent: {
action: 'start',
category: 'application',
label: undefined,
value: undefined
}
}
Fires whenever a borrower attempts to signup in Auth0.
Event Data
{
event: 'mortgagehippo-account-signup',
mortgageHippoEvent: {
action: 'signup',
category: 'account',
label: undefined,
value: undefined
}
}
Fires whenever a borrower attempts to login in Auth0.
Event Data
{
event: 'mortgagehippo-account-login',
mortgageHippoEvent: {
action: 'login',
category: 'account',
label: undefined,
value: undefined
}
}
Fires whenever you click on a task for the first time. This event is always followed by a
Task View
event.Event Data
{
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
}
}
Fires whenever the borrower views a task. This event will also fire whenever the borrower starts an application.
Event Data
{
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
}
}
Fires whenever a task is completed.
Event Data
{
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
}
}
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 Data
{
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,
}
}
Fires when the user selects a pricing option in the Pricing Task.
Event Data
{
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
}
}
Fires when the borrower’s credit report is complete and the scores are displayed to the borrower.
Event Data
{
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
}
}
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 Data
{
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,
}
}
To set up GA, you must send us your GA Property Tracking ID formatted as
UA-XXXXXXXX-X
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 })
If you want to setup both GA and Google Tag Manager (GTM), follow the instructions for GTM as it will flow data into GA.
Once you complete the GTM setup below, you will need to send us your GTM Container ID formatted as
GTM-XXXXXX
You can connect Google Tag Manager (GTM) to track events to your specific needs and consume all the data from the MortgageHippo events.
The instructions below will guide you in setting up GTM together with forwarding events to Google Analytics (GA). Bear in mind that events forwarded to GA will be stripped from certain event data that will be retained in GTM (see details in the GA section above).
Variable | |
Name | Google Analytics Tracking ID |
Type | Google Analytics Settings |
Tracking ID | The GA Propterty ID formatted as UA-XXXXXXXX-X |
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 |
Trigger | |
Name | MortgageHippo Event |
Type | Custom Event |
Event Name | mortgagehippo\-.+ |
Use regex matching | checked |
This trigger fires on | All Custom Events |
Trigger | |
Name | History Change |
Type | History Change |
This trigger fires on | All History Changes |
Tag | |
Name | MortgageHippo Page View - GA |
Type | Google Analytics: Universal Analytics |
Track Type | Page View |
Google Analytics Settings | {{Google Analytics Tracking ID}} |
Triggering | All Pages , History Change |
Tag | |
Name | MortgageHippo Page View - GA |
Type | Google Analytics: Universal Analytics |
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 Tracking ID}} |
Triggering | MortgageHippo Event |
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 modified 7mo ago