Monthly Report

Monthly Insights Notifications aim to provide the energy user with a short, engaging and easily understandable glance at what the previous months energy usage was. It’s meant to push regular and meaningful information to the energy user and drive engagement by encouraging the user to get more details in an app.

The text that is created is short, concise and fits nicely in a text message or a push notification meant to create interest and drive engagement for the energy user to want to know more.

How does it work?

For each Location in the Eliq Platform, events are created and sent out using the Eliq Webhook Solution. Events can be received and the information used to create Push or E-mail notifications that are sent out to each energy user in an app.

The payload looks like this.

{
    "id": "882656c3-f4bd-4b75-a954-b45c68185fba",
    "created_date": "2024-02-01T03:23:00Z",
    "type": "notification_created",
    "object": {
        "location_id": 123,
        "location_ext_ref": "EXT_REF",
        "type": "monthly_insight",
        "message": {
            "sv-SE": {
                "header": "Your consumption in January",
                "content": "You consumed 3456 kWh in January which is about the same as the same month last year. The consumption decreased 45 kWh compared to December. Check out all your insights in the app. "
            }
        },
        "object": {
            "type": "monthly_insight",
            "fuel": "elec",
            "period_start": "2024-01-01T00:00:00.000",
            "period_end": "2024-02-01T00:00:00.000"
        }
    }
}

Webhook Solution

The Eliq Webhook Solution can be used to receive all events that Eliq can provide for different features and to generate notifications to energy users in apps. Read more about how to Get Started using the Eliq Webhook Solution.

API Reference Documentation

Eliq also provides a number of API Endpoints to offer energy users to see their all notification and allow them to configure which notifications they would like to receive or not..

These endpoints are optional to use in an app. It is possible to provide Monthly Insights Notifications to energy users by only implementing the Eliq Webhook Solution and managing energy user notifications settings in other ways.

• The Insights API Endpoint Get Location/{locationId}/notifications returns a list of all notifications that have been created for a Location.
• The Insights API Endpoint Get Location/{locationId}/notifications/settings can be used to get a locations available notifications and their settings.
• The Insights API Endpoint Put Location/{locationId}/notifications/settings can be used to update the energy users notification settings preferences. Changes made are reflected in the endpoint Get Location/{locationId}/notifications/settings

Supported fuel types and Units

Monthly Insights Notifications can be created for

• Electricity – Energy
• Gas – Energy
• District Heating is currently not supported
• Cost is currently not supported

Energy is always returned in kWhs.

Supported Location Profile Types

Monthly Insights notifications can be created for both Residential and Business Locations. For more information about Location Profile Types, please visit the Location Profile article

Requirements

Monthly Insights Notifications are generated when a Locations total energy data for the previous month is available in the platform.

If a Locations energy data for the previous month is lagging or has gaps (missing days or sub-hourly data points), then the Monthly Insights Notification will be skipped.

Eliq will stop trying to send out Monthly Insights Notifications 10 days after the end of the previous month.

If a Monthly Insights Notification has been sent out and data for the previous month is updated after then Eliq will not send out a new notification to the user.

Message content

Each notification is a short, readable summary of the month: how much energy the home used, and how that compares with the previous month and the same month last year. The wording varies from month to month, so the notifications stay worth reading.

Treat header and content as display text and pass them on to the energy user as they are. Don't parse them: for the figures, use period_start and period_end with the Insights API.

Customizing message content

Message content is managed in the Eliq platform and can be adjusted for each client on request. The current message set is available on request.

Messages are created in the language set for each location, so every energy user gets them in their own language.

Additional notification support

Eliq can offer solutions to manage E-mail notifications as well as customizing notifications to Customers needs. Please contact Eliq for more details.

Use Cases

Monthly Push Notifications in an app

‍

‍

Examples of push notifications shown in an app to an energy user

Example of monthly notification inside the app.

‍

‍