Use the configuration API parameters to set values for the general WMI application parameters. Tasks may include:

  • Get a list of configuration parameters in the system
  • Get the details about a configuration parameter
  • Update a configuration parameter value

For details on using the Configuration API, refer to the WMI Configuration API in API Explorer

API Endpoints

These are the endpoints available with the Configuration API. Some parameters are read-only.

Endpoint Method Description
/config GET Gets a list of configuration parameters in the system.
/config/{parameter} GET Gets the details about a configuration parameter.
PATCH Updates the configuration parameter according to policy for the requesting user. See Application Parameters for a list.
This method can only update the parameter value, not the parameter name.


Application Parameters

These are the parameters in the WMI application that you can view or change using the Configuration API. Some parameters are read-only.

Parameter Default Value

Valid values

Description
systemTimePeriod month day, week, month, or year Base time period to use for all system operations, including data storage, analytics and user interface. The base time period determines the most detailed level of time maintained in the system and combined with systemTimePeriodRetention determines the duration of history retained in the system. This is a read-only value.
systemTimePeriodRetention 30 Not configurable from this API. Number of time periods retained in the system. This is a read-only value.
listExportEssentialColLimitRow 50000 Not configurable from this API. Limits the number of customers that can be exported from the UI with essential columns only. This also affects audiences shared in UBX. This is a read-only parameter.

enableChannelPreferenceFeatures

true true or false

Enables UI features related to Channel Preference data.

enableCustomerSpendFeatures

true true or false

Enables UI features related to customer Spend data.

attritionHighRiskThreshold

80 Any integer up to 100.

Attrition scores equal or greater than this value are treated as high risk.

churnCondition

50 Any integer up to 100.

Attrition scores equal or greater than this value are treated as churn risk.

churnThresholdSpikers

65 Any integer up to 100

Attrition scores equal or greater than this value are treated as spike. 

spikeThreshold

50 Any integer up to 100 Attrition delta scores equal or greater than this value are treated as spike. 

segmentShrinkThreshold

50 Any digit up to 100 Percentage of shrinkage in a segment before Insight is triggered.

profileTable

CUSTOMER_PROFILE Not configurable from this API. The customer profile table name. This is a read-only value.

attritionLabel

Attrition Not configurable from this API. Attrition label text. This is a read-only value.
allCustomersListFilters CHURNED_IND=0 WMI Filter Rules A set of filter conditions in WMI rules format to be automatically applied to all audiences in the system, including All Active Customers. Typically used to exclude customer records loaded for model training purposes only.
attritionInputColumns * comma-separated list of profile columns The set of profile columns to be used as input for attrition model
segmentMigrationNumberOfHistoricalPeriods 5 Any integer 5-53 The number of history periods to use for making the segment migration prediction
cltvCostOfSalesPercent 45 Any digit up to 100 Cost of sales includes both the cost of goods sold, and the cost of margin per customer.   Gross contribution is calculated as revenue (TOTAL_PURCHASE_AMT) times (1 – cost of sales percent).
cltvCostOfMarketingPercent 7 Any digit up to 100 Cost of marketing is a separately tracked cost covering promotional costs.
cltvDiscountRate 20 Any digit up to 100 The per period discount rate. 
cltvNumberOfPeriods 10 Number of periods 1-50 The number of periods to project the CLTV.  Periods are not tied to the time grain of the customer profile and typically would be years, though could be longer.
cltvNumberOfSalesCyclesPerPeriod 1 1-12 There could be 1 or more sales cycles per projection period.
cltvScoringMethod DISCRETE_CASH_FLOW CONTINUOUS_CASH_FLOW or
DISCRETE_CASH_FLOW

This drives the formula being chosen.  For discrete cash flow, a specific timing of cash flow is assumed.  All parameters have default values in this mode.  For continuous cash flow, no such specific timing is assumed.  There are additional required parameters that attempt to simulate an S-curve of expected growth in profits, up to an inflection point, and then the decline.

cltvProfitCeiling 1000 1-100,000 The expected profit ceiling per customer in money terms.  This parameter is only required for the continuous cash flow formula
cltvGrowthRate 8 1-1000

The rate at which profit is expected to grow up to the profit ceiling.  .This parameter is only required for the continuous cash flow formula.

cltvInflectionPoint 5 1-50

The period in the profit curve where profit is expected to stop growing.  It should be less than the numberOfPeriods parameter.  This parameter is only required for the continuous cash flow formula.

segmentRules

A valid set of rules to allocate customers to an appropriate engagement segment.

dataFillCarryForwardColumns * comma-separated list of profile columns The set of profile columns to carry forward when filling data for a history period

API Endpoint Examples

Endpoint Action Example
/config GET
curl -X GET --header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config'
/config{parameter} GET
curl -X GET --header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/attritionHighRiskThreshold'
/config{parameter} PATCH
curl -X PATCH -–header 'Content-Type: application/json' -–header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' -d '{ \"value": 50 \
}' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/attritionHighRiskThreshold'

Join The Discussion

Your email address will not be published. Required fields are marked *