Skip to main content
GET
Read insight

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

user_guid
string
required

The unique identifier for a user, beginning with the prefix USR-.

insight_guid
string
required

The unique identifier for the insight. Defined by MX.

Query Parameters

includes
string

Opt in to receiving additional data on insights. Pass ?includes=localization_payload to populate the localization_payload object on each insight.

  • When included, insights with a supported template return localization_payload with is_enabled: true and the template-specific fields populated. Unsupported templates return localization_payload with is_enabled: false.
  • If the parameter is omitted entirely, the localization_payload key is not included in the response at all (it is absent, not null).
  • Currently supported templates: BillAmountNotStandard, MonthlySubscriptionAggregateV2, SubscriptionPriceIncrease. This list may grow as more templates are enabled.

Response

200 - application/vnd.mx.api.v1+json

OK

insight
object