Insights Overview
Use these endpoints to build customizable user experiences in UIs powered by our Financial Insights data.
With Financial Insights, your users will receive personalized insights based on their transaction history.
Want to learn more about the product? See Financial Insights.
Looking for a guide to use these endpoints? See Build Your Own Insights UI.
Insight Fields
| Field Name | Data Type | Definition |
|---|---|---|
active_at | String | The date and time the insight is active, given in ISO 8601 with a timestamp. |
client_guid | String | The unique identifier for the client associated with the insight. Defined by MX. |
created_at | String | The date and time the insight was created, given in ISO 8601 with a timestamp. |
cta_clicked_at | String | The date and time the end user clicked the insight's CTA, given in ISO 8601 with a timestamp. |
description | String | The human-readable information being delivered to the end user. |
guid | String | The unique identifier for the insight. Defined by MX. |
has_been_displayed | Boolean | This indicates whether the insight has been shown to the end user. |
has_associated_accounts | Boolean | This indicates whether there are accounts associated with the insight. |
has_associated_transactions | Boolean | This indicates whether there are transactions associated with the insight. |
has_associated_merchants | Boolean | This indicates whether there are merchants associated with the insight. |
has_associated_scheduled_payments | Boolean | This indicates whether there are scheduled payments associated with the insight. |
is_dismissed | Boolean | This indicates whether the insight has been dismissed by the end user. |
micro_call_to_action | String | Returns a micro CTA if the insight template supports micro copy. |
micro_description | String | A shorter version (300 characters or less) of description. This is the insight's description we display to the end user in the Micro Widget. |
micro_title | String | A shorter version (60 characters or less) of title. This is the insight's title we display to the end user in the Micro Widget. For example, Price Increase or Paycheck Deposit. |
template | String | A short label for the type of insight being delivered, for example, SubscriptionPriceIncrease, MonthlyCategoryTotal, and more. |
title | String | The title for the specific insight, for example, Price Increase or Paycheck Deposit. |
updated_at | String | The date and time the insight was last updated, given in ISO 8601 without a timestamp. |
user_guid | String | The unique identifier for the user to which the insight belongs. Defined by MX. |
user_id | String | The unique partner-defined identifier for the user associated with the insight. |