PluggyDocs
POST/behavior-analysis

Behavior Analysis

Analyzes user behavior and spending patterns across categories from a Pluggy Item.

Request Body

object
itemIdstring

User's item id

Example

json
{
  "itemId": "string"
}

Responses

200200
object
behaviorsobject
hasCarboolean

Default: true

homeownerboolean

Default: true

frequentTravelerboolean

Default: true

highDiningExpenditureboolean

Default: true

investmentActivityboolean

Default: true

educationExpensesboolean

Default: true

healthcareNeedsboolean

Default: true

loanCommitmentsboolean

Default: true

insurancePoliciesboolean

Default: true

metricsobject
transportationobject
travelobject
investmentobject
healthcareobject
loanPaymentsobject
diningobject
educationobject
insuranceobject
housingobject

Example response

json
{
  "behaviors": {
    "hasCar": true,
    "homeowner": false,
    "frequentTraveler": false,
    "highDiningExpenditure": false,
    "investmentActivity": true,
    "educationExpenses": false,
    "healthcareNeeds": true,
    "loanCommitments": false,
    "insurancePolicies": true
  },
  "metrics": {
    "transportation": {
      "spending": 6862.91,
      "transactionCount": 15
    },
    "travel": {
      "spending": 1690.57,
      "transactionCount": 4
    },
    "investment": {
      "spending": 262274.43,
      "transactionCount": 69
    },
    "healthcare": {
      "spending": 688.49,
      "transactionCount": 4
    },
    "loanPayments": {
      "spending": 0,
      "transactionCount": 0
    },
    "dining": {
      "spending": 1200.13,
      "transactionCount": 16
    },
    "education": {
      "spending": 0,
      "transactionCount": 0
    },
    "insurance": {
      "spending": 588.5200000000001,
      "transactionCount": 15
    },
    "housing": {
      "spending": 5.3,
      "transactionCount": 1
    }
  }
}

Code Examples

bash
curl -X POST 'https://enrichment-api.pluggy.ai/behavior-analysis' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Try It