Indicators
The Indicators product lets you retrieve metrics computed on end user’s banking data
Last updated
The Indicators product lets you retrieve metrics computed on end user’s banking data
Last updated
Authentication: endpoint in this page requires header authentication with a user token.
GET https://{domain}.biapi.pro/2.0/users/{userId}/indicators
Get indicators metrics computed on end user’s banking data by user ID.
| Name | Type | Description |
|---|---|---|
Response body: UserIndicators object
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
userId*
Integer
ID of the user
id_user
Integer
Id of the user.
indicators
Indicators object
User's indicators metrics.
avg_current_month
MonthlyIndicators object
Current month average indicators.
total_current_month
MonthlyIndicators object
Current month sum of indicators.
avg_last_30days
MonthlyIndicators object
Last 30 day average indicators.
total_last_30days
MonthlyIndicators object
Last 30 day sum of indicators.
avg_last_60days
MonthlyIndicators object
Last 60 day average indicators.
total_last_60days
MonthlyIndicators object
Last 60 day sum of indicators.
avg_last_90days
MonthlyIndicators object
Last 90 day average indicators.
total_last_90days
MonthlyIndicators object
Last 90 day sum of indicators.
incoming
Integer
Sum/average of positive transactions.
outgoing
Integer
Sum/average of negative transactions.
net_cash_flow
Integer
Sum/average of transactions.
leverage_ratio
String or null
Proportion of total of loans amount compared to total of recurrent income.
recurrent_income
MonetaryAmount object
Recurring income indicators.
recurrent_outcome
MonetaryAmount object
Recurring outcome indicators.
gambling
GamblingIndicators object
Gambling indicators.
loans
LoansIndicators object
Loans indicators.
return_debit
ReturnDebitIndicators object
Return debit indicators.
num_statements
Decimal or Integer
Number of transactions of recurring income categories in the analyzed period. Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.
total_amount
Integer
Sum of transactions of recurring income categories in the analyzed period.
details
String or null
gambling_ratio
String or null
Proportion of total of gambling negative amounts compared to total of recurrent income.
income_num_statements
Decimal or Integer
Number of positive transactions of category Gambling in the analyzed period. Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.
income_total_amount
Integer
Sum of positive transactions of category Gambling in the analyzed period.
outcome_num_statements
Decimal or Integer
Number of negative transactions of category Gambling in the analyzed period.
Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.
outcome_total_amount
Integer
Sum of negative transactions of category Gambling in the analyzed period.
income_num_statements
Decimal
Number of positive transactions of category Loans in the analyzed period.
income_total_amount
Integer
Sum of positive transactions of category Loans in the analyzed period.
outcome_num_statements
Decimal
Number of negative transactions of category Loans in the analyzed period.
outcome_total_amount
Integer
Sum of negative transactions of category Loans in the analyzed period.
details
Array of DetailsIndicators objects or null
List of DetailsIndicators.
category_id
Integer
Id of category.
amount
Integer
Amount of transaction.
date
String
Date in string.
num_statements
Decimal
Number of transactions of category Return Debit in the analyzed period.
total_amount
Integer
Sum of transactions of category Return Debit in the analyzed period.