Deliver dynamic, personalized, and predictive financial insights using widgets
There are two widgets that display insights:
- The Insights Widget, a vertical feed of insights.
- The Mini Widget, a carousel of insights users can swipe through.
Insights are cards that are personalized for a user and appear on the UI. They are based on cleansed, transaction data and inform and guide end-users towards financial wellness.
Before an insight generates, it must meet certain requirements. This means new users may have few or no insights at first. As users connect more accounts, import historical transactions, and make transactions, more insights will generate.
To see what requirements and triggers are needed for an insight to generate, select an insight from the Insights Library on our Academy site, then view the "Requirements and triggers" section.
You'll see references to beats throughout code examples in this documentation. Beats are now called insights.
Insights are generated through templates. Each insight template contains default copy for the title, body, and CTA. The body copy may contain dynamic fields that will populate once an insight following the template is generated. Contact MX to customize any copy for English or other supported languages.
You can request MX set dark mode for your Insights Widget and Mini Widget in two ways:
- We can set it so the mode always defaults to the user's system settings.
- We can set either dark or light mode for all your users.
Platform API vs. SSO API
To access your widgets, you'll either use the Platform API or the SSO API.
The API you use depends on what you have purchased and have enabled. If you have the Nexus API enabled, you'll use the SSO API when integrating a widget.
Nexus API Data Requirements
There's no minimum set of required account or transaction fields that must be passed to MX for Insights to function. Insights are delivered purely on aggregated data. However, because of the relationship between the data available and the insights delivered, more data makes it more likely that an end user can access the full set of insights.
Many factors determine which insights are delivered to which users at what time, ranging from which data fields are populated to the specific conditions met by the data.
For the best results, MX recommends that you can deliver the data outlined in the MDX v5 data specification, and have at least six months of data for each user.
The following table outlines fields in the Nexus API that are important for one or more insights. Some of these fields are provided or aggregated by you, others are defined by MX.
|Account Fields||Scheduled Payment Fields||Transaction Fields||User Fields||Merchant Fields|