Note
The Q2 SMART API is available for FIs that use the Q2 Caliper API. Contact your Customer Success Manager for more information on if the Q2 Caliper API is appropriate for your FI.
Before you can use a trait with the Heuristic Traits API, you must submit a support case to Q2 Support to have the trait added to the Smart Trait Store. You must include the following information in your support case:
-
ID—the unique name for the trait, such as credit_score. The ID can only consist of lowercase letters and underscores. It cannot contain any spaces.
-
Display Name—the name of the trait in the campaign builder, such as Credit Score.
-
Description—the description of the trait in the campaign builder, such as The credit score of the user.
-
Type—the data type of the trait. You can select one of the following data types:
-
Boolean—a data type with two possible values (true/false).
-
Float—a number with a decimal place. You must define the maximum and minimum range in your support case.
-
Enum—a data type with a predefined set of values. For example, you can set a trait that targets end users with airline statuses of gold, silver, or bronze. You must define a list of possible values in your support case. Q2 SMART only supports five values for enum.
-
Date—a time and date in the form of seconds since epoch.
-
Note
Q2 SMART reserves the right to reject trait requests.
FIs can ask for up to five custom traits. FIs are responsible for:
-
Supplying the data for the trait
-
Writing the code that calls for the heuristic traits API.
-
Knowing the Q2 user ID for making the API call.
-
Setting the trait for each user individually (batch setting not supported).
Note
At this time, Q2 SMART cannot support updating the trait with data being sent to Q2 through Q2 Data Services.
For more information on the Heuristic Traits API, see the SMART APIs documentation.