Skip to main content
GET
List insights by transaction
Use this endpoint to list all insights associated with a transaction GUID.

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

transaction_guid
string
required

The unique id for a transaction.

user_guid
string
required

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

Query Parameters

page
integer

Results are paginated. Specify current page.

records_per_page
integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

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

insights
object[]
pagination
object