Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Behavioral Insights (New)

Get Behavioral Insights

Enriches debit transactions with category, merchant, and location data, returning aggregated spend analytics by category, merchant, and geography.

get/insights/v3/behaviors

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

start_datestring date

The start date in UTC (in the format YYYY-MM-DD) of the analysis window. When omitted, defaults to the earliest debit transaction available for the entity.

end_datestring date

The end date in UTC (in the format YYYY-MM-DD) of the analysis window (inclusive — transactions on this date are included). When omitted, defaults to the current time.

Response

OK

type'income' | 'employment' | 'cashflow' | 'credits-obligations' | 'non-credits-obligations' | 'expenses' | 'cash-balances' | 'freelancer-cashflow' | 'behaviors' | 'cashflow-patterns' | 'credit-assessments' | 'account-controls' | 'credit-obligations'

type of insight

Example response

{
  "insights": {
    "behaviors": {
      "by_category": {
        "breakdown": [
          {
            "total_amount": {
              "currency": "AED"
            },
            "average_transaction_amount": {
              "currency": "AED"
            },
            "average_monthly_amount": {
              "currency": "AED"
            },
            "average_monthly_amount_active": {
              "currency": "AED"
            }
          }
        ]
      },
      "by_merchant": {
        "breakdown": [
          {
            "total_amount": {
              "currency": "AED"
            },
            "average_transaction_amount": {
              "currency": "AED"
            },
            "average_monthly_amount": {
              "currency": "AED"
            },
            "average_monthly_amount_active": {
              "currency": "AED"
            }
          }
        ]
      },
      "by_location": {
        "breakdown": [
          {
            "total_amount": {
              "currency": "AED"
            },
            "average_transaction_amount": {
              "currency": "AED"
            },
            "average_monthly_amount": {
              "currency": "AED"
            },
            "average_monthly_amount_active": {
              "currency": "AED"
            }
          }
        ]
      }
    }
  }
}