Skip to main content
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

FieldData TypeDefinition
active_atStringThe date and time the insight is active, given in ISO 8601 with a timestamp.
client_guidStringThe unique identifier for the client associated with the insight. Defined by MX.
created_atStringThe date and time the insight was created, given in ISO 8601 with a timestamp.
cta_clicked_atStringThe date and time the end user clicked the insight’s CTA, given in ISO 8601 with a timestamp.
descriptionStringThe human-readable information being delivered to the end user.
guidStringThe unique identifier for the insight. Defined by MX.
has_been_displayedBooleanThis indicates whether the insight has been shown to the end user.
has_associated_accountsBooleanThis indicates whether there are accounts associated with the insight.
has_associated_transactionsBooleanThis indicates whether there are transactions associated with the insight.
has_associated_merchantsBooleanThis indicates whether there are merchants associated with the insight.
has_associated_scheduled_paymentsBooleanThis indicates whether there are scheduled payments associated with the insight.
is_dismissedBooleanThis indicates whether the insight has been dismissed by the end user.
micro_call_to_actionStringReturns a micro CTA if the insight template supports micro copy.
micro_descriptionStringA 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_titleStringA 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.
templateStringA short label for the type of insight being delivered, for example, SubscriptionPriceIncrease, MonthlyCategoryTotal, and more.
titleStringThe title for the specific insight, for example, Price Increase or Paycheck Deposit.
updated_atStringThe date and time the insight was last updated, given in ISO 8601 without a timestamp.
user_guidStringThe unique identifier for the user to which the insight belongs. Defined by MX.
user_idStringThe unique partner-defined identifier for the user associated with the insight.