> ## Documentation Index > Fetch the complete documentation index at: https://docs.mx.com/llms.txt > Use this file to discover all available pages before exploring further. # Read insight > Use this endpoint to read the attributes of an insight according to its unique GUID. ## OpenAPI ````yaml /openapi/platform-api/v20111101.yaml get /users/{user_guid}/insights/{insight_guid} openapi: 3.0.0 info: contact: name: MX Platform API url: https://www.mx.com/products/platform-api description: > The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. title: MX Platform API version: '20111101' servers: - url: https://int-api.mx.com - url: https://api.mx.com security: - basicAuth: [] tags: - name: authorization - name: widgets - name: users - name: members - name: institutions - name: accounts - name: transactions - name: microdeposits - name: managed data - name: transaction rules - name: statements - name: merchants - name: categories - name: insights - name: investment holdings - name: spending plan - name: goals - name: budgets - name: monthly cash flow profile - name: notifications - name: taggings - name: tags - name: deprecated - name: processor token - name: verifiable credentials - name: rewards - name: ach return paths: /users/{user_guid}/insights/{insight_guid}: get: tags: - insights summary: Read insight description: >- Use this endpoint to read the attributes of an insight according to its unique GUID. operationId: readInsightUser parameters: - $ref: '#/components/parameters/userGuid' - $ref: '#/components/parameters/insightGuid' - $ref: '#/components/parameters/insightIncludes' responses: '200': content: application/vnd.mx.api.v1+json: schema: $ref: '#/components/schemas/InsightResponseBody' description: OK components: parameters: userGuid: description: The unique identifier for a `user`, beginning with the prefix `USR-`. example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 in: path name: user_guid required: true schema: type: string insightGuid: description: The unique identifier for the insight. Defined by MX. example: BET-1234-abcd in: path name: insight_guid required: true schema: type: string insightIncludes: name: includes description: >- 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. in: query required: false example: localization_payload schema: type: string schemas: InsightResponseBody: properties: insight: $ref: '#/components/schemas/InsightResponse' type: object InsightResponse: properties: active_at: example: '2022-01-07T12:00:00Z' nullable: true type: string client_guid: example: CLT-abcd-1234 nullable: true type: string created_at: example: '2022-01-12T18:16:51Z' nullable: true type: string cta_clicked_at: example: '2022-01-13T18:13:51Z' nullable: true type: string description: example: >- Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service? nullable: true type: string guid: example: BET-abcd-1234 nullable: true type: string has_associated_accounts: example: false nullable: true type: boolean has_associated_categories: example: false nullable: true type: boolean has_associated_merchants: example: false nullable: true type: boolean has_associated_repeating_transactions: example: false nullable: true type: boolean has_associated_scheduled_payments: example: false nullable: true type: boolean has_associated_transactions: example: true nullable: true type: boolean has_been_displayed: example: true nullable: true type: boolean is_dismissed: example: false nullable: true type: boolean localization_payload: type: object description: >- Structured, per-template values used to render the insight description and micro_description. The shape depends on the insight `template`. Opt-in: returned only when `?includes=localization_payload` is passed (otherwise the key is absent). When the insight's template is supported, `is_enabled` is `true` and the template-specific fields are populated. When the template is not yet supported, `is_enabled` is `false`. oneOf: - $ref: '#/components/schemas/LocalizationPayloadUnsupported' - $ref: '#/components/schemas/LocalizationPayloadBillAmountNotStandard' - $ref: >- #/components/schemas/LocalizationPayloadMonthlySubscriptionAggregateV2 - $ref: >- #/components/schemas/LocalizationPayloadSubscriptionPriceIncrease micro_call_to_action: example: Learn more nullable: true type: string micro_description: example: Netflix charged you $5.00 more this month than normal. nullable: true type: string micro_title: example: Price increase nullable: true type: string template: example: SubscriptionPriceIncrease nullable: true type: string title: example: Price increase nullable: true type: string updated_at: example: '2022-01-12T18:16:51Z' nullable: true type: string user_guid: example: USR-1234-abcd type: string user_id: example: user-partner-defined-1234 type: object LocalizationPayloadUnsupported: type: object additionalProperties: false required: - is_enabled properties: is_enabled: type: boolean description: >- Whether the localization payload is populated for this insight's template. example: false enum: - false LocalizationPayloadBillAmountNotStandard: type: object additionalProperties: false required: - is_enabled - template - scenario - average_amount - current_amount - higher_or_lower - merchant_name - percentage_change - transaction_month properties: is_enabled: type: boolean description: >- Whether the localization payload is populated for this insight's template. example: true template: type: string enum: - BillAmountNotStandard scenario: type: string nullable: true description: >- The variant for this insight, used to select the appropriate localized string template. Null when the template has only one variant. example: higher average_amount: type: number example: 36.71 description: >- The average bill amount (limited to the five most recent transactions). current_amount: type: number example: 36.71 description: The triggering transaction's amount. higher_or_lower: type: string description: Whether the bill was higher or lower than usual. merchant_name: type: string description: The merchant's name. percentage_change: type: number example: 25 description: >- The percentage increase or decrease between `average_amount` and `current_amount`. transaction_month: type: string example: June 5 description: The month of the triggering transaction. LocalizationPayloadMonthlySubscriptionAggregateV2: type: object additionalProperties: false required: - is_enabled - template - scenario - amount_sum - count - date properties: is_enabled: type: boolean description: >- Whether the localization payload is populated for this insight's template. example: true template: type: string enum: - MonthlySubscriptionAggregateV2 scenario: type: string nullable: true description: >- The copy variant for this insight, used to select the appropriate localized string template. Null when the template has only one variant. example: null amount_sum: type: number example: 36.71 description: The total value of all of those subscriptions. count: type: integer example: 3 description: >- The total number of merchants from which subscription transactions were detected for the period. date: type: string example: June 5 description: The date the beat was generated. LocalizationPayloadSubscriptionPriceIncrease: type: object additionalProperties: false required: - is_enabled - template - scenario - increase_amount - merchant_name properties: is_enabled: type: boolean description: >- Whether the localization payload is populated for this insight's template. example: true template: type: string enum: - SubscriptionPriceIncrease scenario: type: string nullable: true description: >- The copy variant for this insight, used to select the appropriate localized string template. Null when the template has only one variant. example: null increase_amount: type: number example: 36.71 description: The amount the subscription price increased. merchant_name: type: string description: The merchant name associated with the subscription. securitySchemes: basicAuth: scheme: basic type: http ````