Beats Overview

Deprecated

The Beats endpoints are no longer supported.

Beats are personalized financial insights delivered to users based on their financial data and behavior patterns.

Beat Fields

Field name	Data type	Definition
account_guids	array	An array of account GUIDs that are relevant to the information delivered in the beat.
created_at	string	The date and time the beat was created, given in ISO 8601 with a timestamp.
description	string	The human-readable information being delivered to the end user.
digest	string	A unique identifier derived from inputs to the beat which ensures beats are not duplicated.
displayed_at	string	The date and time at which the beat was displayed to the end user, given in ISO 8601 with a timestamp.
guid	string	The unique identifier for the beat. Defined by MX.
has_been_displayed	boolean	This indicates whether the beat has been shown to the end user.
is_dismissed	boolean	This indicates whether the beat has been dismissed by the end user.
is_relevant	boolean	This indicates whether a beat still contains information that is relevant, meaningful, or useable to the end user. For example, an OverdraftWarning will have is_relevant set to false if a large deposit is made into the associated account after the beat was created. Any beat which has already been displayed to or dismissed by the end user will be set to false. There are numerous examples and conditions.
primary_account_guid	string	The unique identifier for the account most relevant to the information delivered in the beat.
primary_transaction_guid	string	The unique identifier for the transaction most relevant to the information delivered in the beat.
template	string	A short label for the type of beat being delivered, e.g., SubscriptionPriceIncrease or MonthlyCategoryTotal.
title	string	The title for the specific beat, e.g., Price Increase or Paycheck Deposit.
transaction_guids	array	An array of transaction GUIDs that are relevant to the information delivered in the beat.
updated_at	string	The date and time the beat was last updated, given in ISO 8601 without a timestamp.
user_guid	string	The unique identifier for the user to which the beat belongs. Defined by MX.