Savings Increased Compared to Historical Average

Overview

The Savings Increased Compared to Historical Average insight is a schedule-trigger insight that lets the user know if the user's savings has increased more than a user-defined threshold compared to a user-defined duration. This insight will only be generated if the balance has increased.

Following are the additional details for the insight:

Insight Name	SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Container	BANK, INVESTMENT

Use Cases

Customer:
- Cross-Sell / Up-Sell opportunity - Prompt users to move extra money to any of the FI's investment offerings.
User:
- Financial wellness - Keep track of savings.

Suggested Action

Suggest the user to move any excess into an account that earns higher returns.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.

The following is the applicable frequency for this insight:

Frequency	Description
MONTHLY	The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example: Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

Frequency

Description

MONTHLY

The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month).
For example:

Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January.
Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight can be triggered using the following on-demand insight trigger API:

POST /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets the customer or the user decide when the user has to be alerted about the overall savings.

Threshold Name: CHANGE
Data Type: PERCENT
Range Allowed: 0.00 <= CHANGE <= 500.00
Default: 10.00

Note: Depending on the customer segment and account, the threshold might need to be different for different users. If the default value is insufficient, the users can set a threshold they are comfortable tracking.

GET Customer Subscription

The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer. The default frequency for the insight is MONTHLY and the default duration for the insight is LAST_THREE_MONTHS.

Method and URL:

GET /insights/configs/customerSubscriptions

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/customerSubscriptions

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

Api-Version 3.0 and 2.1 Response

{
   "customerSubscription":[
    {
            "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
            "insightTitle": "Savings increased compared to historical average",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when the overall savings of the user has increased by a defined threshold percentage compared to their historic average savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
    {
            "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
            "insightTitle": "Savings increased compared to historical average",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when the overall savings of the user has increased by a defined threshold percentage compared to their historic average savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
   ]
}

PATCH Customer Subscription

Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.

Warning! Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.

Method and URL:

PATCH /insights/configs/customerSubscriptions

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Savings Increased Compared to Historical Average insight.	true, false
insightTitle	The title returned in the GET feed API as well as the insights config tool can be changed.	Alphanumeric characters up to 100 characters (including spaces)
duration	The data range that should be considered for evaluating the insight.	LAST_THREE_MONTHS LAST_SIX_MONTHS LAST_TWELVE_MONTHS
threshold	The threshold (CHANGE PERCENT) can be modified.	Any number between 0.00 and 500.00.

Sample Request:

{
  "customerSubscription": [
    {
      "customerConfiguration": [
        {
          "duration": "LAST_THREE_MONTHS",
          "isSubscribed": true,
          "entityType": "ACCOUNT",
          "threshold": [
            {
              "name": "CHANGE",
              "type": "PERCENT",
              "value": "11"
            }
          ]
        }
      ],
      "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE"
    }
  ]
}

Response Messages:

HTTP Status Code	Reason
400	Y806: Invalid Input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for insightTitle; special characters ><\""'%{}\|^~[] are not supported.
400	Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400	Y800: Invalid value for CHANGE in SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight Min = 0.00 and Max = 500.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying applicableEntity is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying triggerType is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying container is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying description is not allowed
400	Y800: Invalid value for isSubscribed; Supported values are true, false
400	Y825: Update not allowed without a valid request body
400	Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required.
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying frequency is not allowed
400	Y800: Invalid value for duration; Supported values are LAST_THREE_MONTHS,LAST_SIX_MONTHS,LAST_TWELVE_MONTHS
400	Y812: Required field/value - insightName missing in the request
400	Y802: Modifying InsightType attribute is not allowed
400	Y813: entityType should be provided
400	Y803: At least one additional attribute is required in addition to entityType.
400	Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes.
400	Y800: Invalid value for entityType. Supported entityType for SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight are - [ACCOUNT]
400	Y802: For SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight, {Invalid String} inside the threshold is not allowed
400	Y800: Invalid value for input json
401	Y020: Invalid token in authorization header
401	Y020: Token has expired

GET User Subscription

The GET user subscription API provides all the information about the user defaults set for the insight.

The entityId filter cannot be passed for this insight.

Method and URL:

GET /insights/configs/userSubscriptions

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/userSubscriptions?insightName=SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

Api-Version 3.0 and 2.1 Response

{
   "userSubscription":[
    {
            "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
            "insightTitle": "Savings increased compared to historical average",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when the overall savings of the user has increased by a defined threshold percentage compared to their historic average savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
    {
            "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
            "insightTitle": "Savings increased compared to historical average",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when the overall savings of the user has increased by a defined threshold percentage compared to their historic average savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_THREE_MONTHS",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "10",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
   ]
}

PATCH User Subscription

Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.

Method and URL:

PATCH /insights/configs/userSubscriptions

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes from the insight.	true, false
duration	The data range that should be considered for evaluating the insight.	LAST_THREE_MONTHS LAST_SIX_MONTHS LAST_TWELVE_MONTHS
threshold	The threshold (CHANGE PERCENT) can be modified.	Any number between 0.00 and 500.00.

Sample Request:

{
  "userSubscription": [
    {
      "insightName": "SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
      "userConfiguration": [
        {
          "duration": "LAST_THREE_MONTHS",
          "isSubscribed": true,
          "entityType": "ACCOUNT",
          "threshold": [
            {
              "name": "CHANGE",
              "type": "PERCENT",
              "value": "11"
            }
          ]
        }
      ]
    }
  ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight
400	Y802: Modifying insightTitle using this API is not allowed
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y800: Invalid value for threshold data in SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight
400	Y800: Invalid value for CHANGE in SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight Min =0.00 and Max = 500.00
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying applicableEntity is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying triggerType is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying container is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying description is not allowed
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, modifying frequency is not allowed
400	Y800: Invalid value for duration; Supported values are LAST_THREE_MONTHS,LAST_SIX_MONTHS,LAST_TWELVE_MONTHS
400	Y800: Invalid value for isSubscribed; Supported values are true, false
400	Y825: Update not allowed without a valid request body
400	Y812: Required field/value - insightName missing in the request
400	Y802: Modifying InsightType attribute is not allowed
400	Y813: entityType should be provided
400	Y803: At least one additional attribute is required in addition to entityType.
400	Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes
400	Y802: For insight SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE, configurations at an entityId level are not allowed
400	Y800: Invalid value for entityType. Supported entityType for SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE insight are -[ACCOUNT]
400	Y800: Invalid value for input json
401	Y020: Invalid token in authorization header
401	Y020: Token has expired

GET Insight Feeds

The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, the Savings increased compared to historical average insight can be specifically requested.

The entityId filter cannot be passed for this insight.

Calculation Logic for Derived Attributes:

totalAvailableBalance = Sum of all the eligible accounts’ balance will be overall savings amount.
averageAvailableBalance = Sum (each month total balance) / number of months in duration
changeAmount = (totalAvailableBalance - averageAvailableBalance)
changePercent = (changeAmount)/averageAvailableBalance

Method and URL:

GET /insights/feed

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"60d43dbed59fdb46b0c91208",
         "insightName":"SAVINGS_INCREASED_COMPARED_TO_YOUR_AVERAGE",
         "insightTitle":"Savings increased compared to historical average",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T08:09:31Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"LAST_THREE_MONTHS",
               "threshold":[
                  {
                     "name":"CHANGE",
                     "value":"10",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "basicAccount":[
            {
               "id":13709569,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- Account Balance",
               "accountType":"SAVINGS",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709569"
               }
            },
            {
               "id":13709572,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- All Category",
               "accountType":"OTHER",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709572"
               }
            },
            {
               "id":13709567,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data_Sch/Ref",
               "accountType":"CHECKING",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709567"
               }
            }
         ],
         "accountDerived":{
            "totalAvailableBalance":{
               "amount":250054.99,
               "currency":"USD"
            },
            "averageAvailableBalance":{
               "amount":223499.98,
               "currency":"USD"
            }
         },
         "changeValue":[
            {
               "changeType":"SAVINGS_AMOUNT",
               "changeAmount":{
                  "amount":26555.01,
                  "currency":"USD"
               },
               "changePercent":11.88
            }
         ]
      }
   ]
}