Using Galxe to Handle Your Loyalty Program
As a project with an existing loyalty program, you already understand the significance of acknowledging and incentivizing user loyalty.
With Galxe's comprehensive Loyalty Point System, you can take community engagement and retention to new heights. By migrating your loyalty program to Galxe, you gain access to a range of features, including customizable rewards, gamification techniques, and analytics tools, enabling you to create a vibrant and highly rewarding experience for your community.
To facilitate a smooth transition, Galxe offers the "issueLoyaltyPoints" API, which allows you to seamlessly backfill users' loyalty points based on their historical achievements. This API simplifies the process of batch-filling accounts with varying point values, ensuring that your users' loyalty seamlessly transfers to Galxe's platform.
How to Manage Your Leaderboard on Galxe
There are a few ways to reward users with loyalty points on Galxe, and as such there are methods to update your leaderboard and ensure that loyalty points are rewarded to the right users.
Using the API to Update Loyalty Points
To use the "issueLoyaltyPoints" API effectively, there are a few requirements that you need to keep in mind:
Only Space admins have the authority to issue loyalty points using this API.
You must have the necessary permission for the Graphigo service to proceed.
An authorization token is mandatory for all API requests.
An authorization token ensures secure access to the API and must get included in the header of your API requests.
The format of the header should follow the structure below:
{"access-token": "your_token_here"}
To generate the access token, please visit the Galxe user setting page. Once obtained, make sure to include it in the header when making API requests for proper authentication and authorization.
Updating User Loyalty Points: Backfilling Points
To backfill users' loyalty points on Galxe, you will need to utilize the "issueLoyaltyPoints" API.
Here are the details of this API:
API endpoint: https://graphigo.prd.galaxy.eco
Parameters:
space id: The unique identifier of the Space where the points will be issued.
points: The number of points to be issued to each user.
ids: A list of account identifiers to which the points will be issued. Note that the maximum number of ids allowed per request is 200.
idType: The type of account identifier. Currently, the available options include ADDRESS, EMAIL, DISCORD, and TWITTER.
Example API Request:
mutation issuePoints {
issueLoyaltyPoints(
input: {
spaceId: 28,
points: 20,
ids: ["[email protected]"],
idType: EMAIL
}
) {
successIds
failureIds
notFoundIds
message
}
}
Refer to this image as an example:
By making a POST request to the specified API endpoint with the appropriate parameters, you can issue loyalty points to your users on Galxe.
Step-by-Step: Backfilling Points
Ensure that you provide the correct space id, points value, list of ids, and idType to execute the API request successfully.
Follow these steps to update a users loyalty points:
Ensure Space ID: Make sure you have the correct space id for the Space where you want to issue the points. If you don't have it, you will need to retrieve it first.
Determine Point Value: Decide on the number of points you want to issue to each user as part of the backfill process.
Prepare User IDs: Create a list of ids that correspond to the user accounts to which you want to issue the loyalty points. Note that you can include up to 200 ids in a single request.
Specify ID Type: Determine the idType for the account identifiers in the list. The available options are ADDRESS, EMAIL, DISCORD, or TWITTER.
Make API Request: With all the necessary parameters ready, make a graphigo request to the issueLoyaltyPoints API endpoint.
ℹ️ Note: Remember to include your authorization token in the request header to ensure secure access.
Manually Updating Points (CSV Upload)
You can directly adjust your leaderboard by manually uploading a CSV file while you are on the leaderboard tab.
The page should looks like this 👇
After selecting ‘Upload CSV’ review the file reminders.
File Reminders:
The CSV file can only contain two columns:
EVM Address.
Loyalty Points.
A CSV file can have a maximum of 10k addresses.
Point values can only be a positive integer. (No negative values)
For upload errors, please double-check your CSV file for incorrect data.
You can upload a maximum of 5 CSV files at one time.
Most importantly, ensure that your data is clean and correctly formatted.
Input a reason for adjusting the leaderboard.
For example, a campaign didn’t work as intended, or a user reported they did not have the correct number of points.
Select ‘Upload’ after reviewing the CSV file and ensure the data is correct.
You can use the history tab to reference previous CSV uploads.
ℹ️ Note: The most common errors are resolved by thoroughly reviewing the data in a CSV file.
You can only update 10,000 addresses at once.
Upload a separate file to adjust additional addresses beyond 10K.
With an upload limit of 5 files, you may update 50K addresses.
Updating Loyalty Points (FAQs)
Here are some important notes to keep in mind while using the API:
Double-check IDs and ID Type: Always verify the accuracy of your
idsandidTypeparameters. Providing incorrect values can result in points being issued to the wrong accounts or the request failing altogether.Check API Response Messages: After making the API request, check the response message for important information. The response may include the following messages:
"Successfully backfilled xxx users": This message indicates that the API has successfully backfilled the specified number of users with loyalty points.
"*** can't be found on Galxe. Please inform users to bind their [ID type] on Galxe.com first, then try to backfill them again": This message suggests that certain users could not be found on Galxe. In such cases, inform the respective users to bind their respective account types ([ID type]) on Galxe.com before attempting to backfill them again.
"Backfill *** failed, please try to backfill them again": This message indicates a failure in backfilling loyalty points for certain users. Retry the backfill process for these users.
"No access": This message signifies that you do not have the necessary administrative privileges for the specified space, or you have not provided the required access token.
Backfilling Points and User Limitations: Note that the API supports backfilling points only once, and each user can be issued points only once. If a user has both a Discord account and a Twitter account associated with the same Galxe account, points can only be issued once for that account. You can call the API multiple times with different ID types, but it will not result in duplicate points for a user. For example, you can first backfill with EVM addresses and then backfill with your users' Twitter accounts. If both the EVM address and Twitter account belong to the same Galxe user, they won't receive points twice.