The Home Profile is used to collect data from end users.
The Home Profile is used to collect data from an the end user that describes their home. The information in the Home Profile is used to provide energy insights. For example, comparing the Energy Usage to Similar Homes or Energy Usage Categories.
Having a Home Profile is key to get the best Energy Insights from an end user perspective, the more data that a user has filled in, the more accurate the results. At the same time, finding a balance between long onboarding flows and providing an end user the value that an app can provide is important.
Information collected from end users can be used to better understand a customer base. The can be exported to use for other purposes such as marketing campaigns.
Note! This Feature and the included endpoints have been Deprecated from the Insights API. The feature is still supported and maintained but it has been replaced with the Location Profile feature. The Location Profile replaces and improves upon the capabilities of the Home Profile feature capabilities by adding support for both residential homes and business locations, ability to support versions of location profile values and improved API implementations.
A home profile is customised per country or market so that the questions asked and the options presented to the end user makes sense for the types of homes and appliances that are commonly used. Home Profiles can also be configured per customer if requested.
Customising the Home Profile per customer is done together with our Data Science team to ensure that the content and properties are correctly used in Eliqs algorithms that provide energy insights.
The result is a Home Profile that is appropriate for each Location that can help end users to quickly and easily fill in the correct information to get maximum value out of an app both in an onboarding journey and later on in the app.
A Home Profile can be dynamic in an app with the question that an end user is exposed to that change depending on the previous question. For example, if an end user selects that they live in an apartment
, then the questions that follow can be adapted to most sense to those that live in apartments. For example, certain heating types can be skipped, as well as asking about pool. The objectdependent_properties
exists for properties where dynamics should be added. The value contains a list of keys that should exist for the current Location to determine if the question should be presented to the end user.
Home Profile questions can also be added or removed in the Eliq platform to ensure that any changes that make sense to ask the end users are reflected in an app. If a new home profile question is added to the Home Profile Configuration, these can automatically show up to new users who onboard.
A good onboarding experience is key to any app. Key home profile questions need to be filled in to ensure that an end user gets value back in terms of Energy Insights that depend on them. At the same time, balancing the time spent on the onboarding flow vs. letting the user explore an app is important.
The home profile configuration is_required
is a flag that is added to all home profile questions that should be part of an onboarding flow or that can be skipped. Setting the value to true
can determine which questions must be filled in during an onboarding flow, making it easy to build an app that can adapt to the configuration property if new properties are added or if changes to the onboarding flow should be made.
is_required: true
are questions that should be part of an onboarding flowis_required: false
are questions that can be left out but that could still be highlighted in a “Home Completion card” in an app (see use case below).Home profile configurations can be configured and adapted for different needs. The properties is_required
and dependent_properties
can be configured to fit different needs. Please contact Eliq for any configuration needs.
A few endpoints are relevant to provide the best end user experience.
The endpoint Get Location home profile will return home profile questions, home profile options to ask the end user to select or fill in, dependent properties for dynamics, as the any selected values for any home profile question (if the user has filled in any).
Patch Location Home profile is used to add, edit or delete home profile information for each Location during an onboarding journey or in an app
An updated Home Profile is key to providing the best insights. To help users understand if they have filled in everything or if there is something that they can do to improve energy insights accuracy, the Get Location home profile completion endpoint can be used to show a home profile completion percentage in an app (see use case below).
Questions that are required
Questions that are not required but would increase estimated consumption and breakdown
Examples of how you can introduce home profile and explain why it’s important.
If you want a shorter and smoother onboarding it could be a good idea to let users only answer the required question in the home profile. In this case we have used the home profile card to let users complete the full home profile later.