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:

  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.

Maxwell Events

Following is a list of the analytics events that Maxwell tracks. Each event describes the data associated with it.

Application Start

Fires whenever an anonymous application is created.

{
  event: 'mortgagehippo-application-start',
  mortgageHippoEvent: {
    action: 'start',
    category: 'application',
    label: undefined,
    value: undefined
  }
}

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

Fires whenever a borrower attempts to login in Auth0.

{
  event: 'mortgagehippo-account-login',
  mortgageHippoEvent: {
    action: 'login',
    category: 'account',
    label: undefined,
    value: undefined
  }
} 

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

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

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

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

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

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

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)

To set up GA, you must send us your GA Property Tracking ID formatted asUA-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.

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