Profile: Current User Group
User Groups in Capillary represent collections of users (customers or contributors) grouped together for participating in group-based loyalty programs or business engagements, particularly useful for B2B and B2C loyalty scenarios.
This profile allows you to write conditions based on the properties of the user group that is currently involved in the activity.
Attributes - Group Identity
The below grouping of attributes is based on user group identity information.
| Attributes | Definition | Link |
|---|---|---|
| name | User Group's Name. | Learn More |
| externalId | User Group's External ID. | Learn More |
| createdDate | Date when the user group was created. | Learn More |
Attributes - Group Membership
The below grouping of attributes is based on user group membership information.
| Attributes | Definition | Link |
|---|---|---|
| memberCount | Total number of members in the user group. | Learn More |
Attributes - KPI based on Points
The below grouping of attributes is based on the Key Performance Indicators on user group's points.
| Attributes | Definition | Link |
|---|---|---|
| currentPoints | User Group's current redeemable points. | Learn More |
| initialCurrentPoints | User Group's current redeemable points before evaluating the event. | Learn More |
| currentAllPoints | The sum of all Points, redeemable as well as Promised Points for the group. | Learn More |
| initialCurrentAllPoints | The sum of all Points before evaluating the event. | Learn More |
| currentNonRedeemablePoints | User Group's current non-redeemable points. | Learn More |
| lifetimePoints | Total points earned by the user group from the date of creation. | Learn More |
| lifetimeAllPoints | The sum of lifetimePoints and lifetimeNonRedeemablePoints for the group. | Learn More |
| lifetimeNonRedeemablePoints | Total non-redeemable points earned by the user group from date of creation. | Learn More |
| initialLifetimePoints | User Group's lifetime redeemable points before the current event. | Learn More |
Attributes - KPI based on transaction data
The below grouping is done based on the Key Performance Indicators on the user group's transaction data.
| Attributes | Definition | Link |
|---|---|---|
| numberOfTxns | Number of transactions since the creation date of the user group. | Learn More |
| numberOfTxnsToday | Number of transactions made by the user group on the current day. | Learn More |
| numberOfVisits | Number of unique days when the user group made transactions. | Learn More |
| lifetimePurchase | User Group's purchases since creation including current transaction's purchase. | Learn More |
| initialLifetimePurchase | User Group's purchase since creation before current transaction's purchase. | Learn More |
Attributes - Slab Information
This grouping of attributes is done on the basis of Tier/Slab Information associated with the user group's loyalty.
| Attributes | Definition | Link |
|---|---|---|
| initialSlabName | Initial slab name of the User Group before evaluating an event. | Learn More |
| initialSlabNumber | Initial slab number of the User Group before evaluating an event. | Learn More |
| slabName | User Group's current tier name. | Learn More |
| slabNumber | Current User Group slab number (e.g., 10, 1, 3, etc.). | Learn More |
| slabChangeDate | Date when the user group's slab was last changed. | Learn More |
| slabExpiryDate | Date when the user group's current slab will expire. | Learn More |
Attributes - Extended Fields
The below grouping of attributes is based on extended fields configured at the organization level for user groups.
| Attributes | Definition |
|---|---|
extFieldugextfieldname | Access extended field values for the user group. Replace "extfieldname" with the actual extended field name configured for your organization (e.g., extField_ug_primary_user, extField_ug_registration_date"). |
Updated 3 days ago