Insights
Follow this documentation to see what are the endpoints you can call to get all about Insights.
List all Insights Profile#
This endpoint is used to get all previous profiles created for a specific customer. Profiles are groups of Insights attributes set up to show only some parts of Insights. Once you have the list of profiles, you can do a search by a specific profile id.
Method: POST
Endpoint: {{env}}/api/insights/Profile/filter
- Response
Response
| Parameter | Type | Description |
|---|---|---|
| CurrentPage | number | The current page |
| PageSize | number | The amount of rows returned in the current page |
| TotalCount | number | The total rows the filter returns |
| Items | List of profiles | |
| Id | guid | Profile id |
| Name | string | Name |
| CustomerId | guid | Customer Id |
| CreatedAt | datetime | When the profile was created |
| InsightProfileItems | List of profile items | |
| Id | guid | Profile item id |
| DataDictionaryId | guid | Data dictionary id |
| Attribute | string | * if available |
| Period | string | Period |
| InsightsType | string | Insights Type |
View the Profile of a User#
This endpoint is used to get a specific group of Insights attributes according to the previous profile created.
Method: POST
Endpoint: {{env}}/api/insights/GetInsightsProfile
- Payload
- Response
Response
| Parameter | Type | Description |
|---|---|---|
| Value | guid | The corresponding value |
| InsightsType | string | Insights type |
| Period | string | Inform the period, Use the table below for valid options |
| Title | string | Attribute title |
Period
| Period |
|---|
| CurrentMonth |
| OneMonthAgo |
| TwoMonthsAgo |
| ThreeMonthsAgo |
| FourMonthsAgo |
| FiveMonthsAgo |
| SixMonthsAgo |
| SevenMonthsAgo |
| EightMonthsAgo |
| NineMonthsAgo |
| TenMonthsAgo |
| ElevenMonthsAgo |
Get Insights#
This endpoint is used to get the full Insights from a user in a specific period of time.
Method: POST
Endpoint: {{env}}/api/insights/GetInsights
- Payload
- Response
{
"statusCode":
200
"message":
"POST Request successful."
"isError":
false
"result":{
"Expenses":{
"GroupCategory":{
"bills&utilities":{
...
}"entertainment":{
...
}"fees&charges":{
...
}"financial":{
...
}"food&dining":{
...
}"gifts&donations":{
...
}"health&fitness":{
...
}"home":{
...
}"investments":{
...
}"loans":{
...
}"otherexpense":{
...
}"pets":{
...
}"shopping":{
...
}"taxes":{
...
}"transfer":{
...
}"travel":{
...
}"uncategorized":{
...
}"Total":{
"period0":{
...
}"period1":{
...
}"period2":{
...
}"total":{
...
}"Income":{
"GroupCategory":{
"employmentincome":{
...
}"governmentincome":{
...
}"otherincome":{
...
}"transfer":{
...
}"uncategorized":{
...
}"Total":{
"period0":{
...
}"period1":{
...
}"period2":{
...
}"total":{
...
}"Insights":{
"BalanceAnalysis":{
"AvgBalWithdrawnOnPayday":
115.44
"AvgBalDaysAfterPaydays":
"1209.00"
"FraudDetection":{
"AverageOperationsBalance":
225.85
"AccountAgeDays":
2
"CountNsfFee":
0
"ListofNSFtransactions":[
...
]"CountStopPayment":
0
"ListofStopPYMTtransactions":[
...
]"CheckingsDaysWithNegativeBalance":
0
"ListDaysWithNegativeBalance":[
...
]"CountLoanFeesAndCharges":
0
"ListofLoanFEEStransactions":[
...
]"DebtActivityTrend":
"Consistent"
"CreditActivityTrend":
"Decreasing"
"OperationBalanceTrend":
"Consistent"
"IncomeDetected":
"No"
"FreeCashFlow":{
"CurrentOperationsBalance":
1500.97
"CurrentChequingBalance":
2500.97
"CashFlowRecord":
"Positive"
"RecurringPayments":
14.5
"CurrentCreditBalance":
0
"LargeTransaction":[
...
]"TopFiveRecurringPayments":[
...
]"EmployerInfo":{
"Name":
"Insufficient Data"
"AverageAmount":
750.33
"TotalEmploymentIncome":
5750.5
"IncomeTrend":
"Consistent"
"Frequency":
"15 days"
"ListofEmpIncome":[
...
]"NonEmployerInfo":{
"AverageNonEmployerIncome":
540.98
"TotalNonEmployerIncome":
2035.97
"AverageGovernmentIncome":
0
"TotalGovernmentIncome":
0
"AverageSavingAndInvestmentIncome":
0
"TotalSavingAndInvestmentIncome":
0
"NonEmploymentIncomeTrend":
"Decreasing"
"SalaryAnalysis":{
"MortgagePercentageOverSalary":{
...
}"LoanPercentageOverSalary":{
...
}"GamblingPercentageOverSalary":{
...
}"CannabisAndAlcoholPercentageOverSalary":{
...
}"CrCardPercentageOverSalary":{
...
}"Total":{
"period0":{
"Amount":
1246
"Percentage":
23.37
"Transactions":[]
"period1":{
"Amount":
4084.8
"Percentage":
76.63
"Transactions":[]
"period2":{
"Amount":
0
"Percentage":
0
"Transactions":[]
"total":{
"Amount":
5330.8
"Percentage":
100
"Transactions":[]
"Periods":{
"period0":
"Aug-2022"
"period1":
"Jul-2022"
"period2":
"Jun-2022"
InsightPeriod
| InsightPeriod |
|---|
| 60 |
| 90 |
| 180 |
| 360 |