Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Manage Loyalty Attributes

Prev Next

Types of attributes used in the Loyalty Hub

You can view the available attributes in the Loyalty Hub under Users > Attributes. There are two types of attributes you can use in the Loyalty Hub:

  • Standard and custom attributes from the Xtremepush CDP. These are available under Data > Data Manager> Attributes and tags. For more information on how to configure these attributes, see Attributes and Tags.

    To use any custom attributes in the Loyalty Hub, you must first configure them in the Xtremepush CDP. These are the primary attributes you use in the Loyalty Hub to create segments or restrictions in your loyalty features. For more information on where attributes are used in the loyalty hub, see Prerequisites.

    The supported attribute types in the Loyalty Hub are number, string, boolean, and array of strings. This means that Date attributes created in Data Manager are mapped to a string attribute type in the Loyalty Hub. And Integer attributes are mapped to the number attribute type.

  • Standard loyalty system attributes that are preset in the Loyalty Hub.

    The standard preset loyalty attributes do not currently reflect in Xtremepush Data Manager. This means that any changes to these attribute values for each user are only recorded in the Loyalty Hub.

The following table lists these system attributes:

Name

Data Type

Description

redeemOption.tokensRedeemed

number

Total number of tokens redeemed by a user.

quest.completionsById

Record<string, number>

Records the completion status of quests per user.

quest.lastCompletedAtById

Record<string, string>

Records the timestamp of when a quest was completed.

quest.completionsTotal

number

Total number of quests completed by a user.

quest.completedIds

array of strings

Contains the IDs of quests that have been completed by a user.

quest.acceptedIds

array of strings

Contains the IDs of quests that have been accepted but not yet completed by a user.

level.current

number

Represents the current level of the user.

redeemOption.successTransactions

number

Displays the total number of successful transactions made by a user. A transaction refers to when a user exchanges tokens for a redeem option. This value updates when the token amount is withdrawn from the user balance and the reward distribution integration confirms a successful transaction.

perk.slots

number

Indicates the number of perk slots available for a user.

bonus.dailyClaimed

string

Tracks the daily bonus claim status for a user. The last claim date is in ISO format.

reward.primaryReward

number

Total number of tokens earned by the user.

You can also add automations or rewards to any attribute if required. See Add Attribute Automations and Configure Attribute Rewards for more information