Retrieve all configured settings on Gameball through this endpoint
This endpoint allows you to retrieve your configured settings on Gameball account which can be used while creating your custom UI for the player profile on your website or mobile app.
It is very important to use this endpoint while building your own UI to keep all configurations related to Gameball are variable. No need to update your loyalty program static content inside your website or mobile app every time you change them through Gameball admin dashboard.
This endpoint is only available for our GURU customers only 👑
This API call is used to retrieve your configured Gameball Settings along with all Gameball Programs Configurations.
Request
Header
Attribute
Type
Required
Description
APIKey
string
Yes
Client API key
Query Parameters
Attribute
Type
Required
Description
lang
string
No
Language filter. This could be used to specify the language needed to display your configurations in. If not provided, the response would be in default language.
Note: The language provided should be as per configured languages in your account.
Example: "en", "fr".
Response
Parameter
Type
Description
currency
string
Configured Currency
Example: "USD", "EUR".
programName
string
Name of your program.
Example: "TRIPLE H Store"
rankPointsName
string
Name of the rank points, measuring player's progress.
walletPointsName
string
Name of the points (monetary value).
botMainColor
string
The main color of your bot as configured from your Gameball dashboard.
controlConfig
object
An object describing the activity of the main factors.
levels
array
An array of level objects describing each level along with its configurations
challenges
array
An array of challenge objects describing each level along with its configurations
referral
object
An object describing the referral program configurations.
cashback
object
An object describing the cashback program configurations
redemption
object
An object describing theredemption configurations
The redemption object is described as follows
redemptionFactor: Indicates the monetary value which one point is equivalent to.
Example: Redemption Value of 1 point is 0.01 (redemption factor).
redemptionRules: Array of Redemption Rule objects eachdescribed as follows:
ruleId: Unique Identifier for the rule.
type: Redemption Rule type.
Example: "FreeProduct" | "FreeShipping"
equivalentPoints: Equivalent amount of points to be redeemed
equivalentPointsValue: Equivalent monetary value of the specified points.
productId: In case the rule type is "FreeProduct", the productId is the unique identifier of the product to be available for redemption
productName: In case the rule type is "FreeProduct", the productName is the name of the product to be available for redemption
controlConfig Object
Parameter
Type
Description
gameballEnabled
boolean
Indicates whether Gameball is enabled or not.
redemptionEnabled
boolean
Indicates whether redemption configurations is enabled or not.
cashbackEnabled
boolean
Indicates whether cashback program is enabled or not.
referralEnabled
boolean
Indicates whether referral program is enabled or not.
visitorProfileEnabled
boolean
Indicates whether guest view is enabled or not.
userProfileEnabled
boolean
Indicates whether user view is enabled or not.
leaderboardEnabled
boolean
Indicates whether Leaderboard configurations are enabled or not.
notificationsEnabled
boolean
Indicates whether Notifications configurations are enabled or not.
achievementsEnabled
boolean
Indicates whether Achievements configurations are enabled or not.
level Object
Parameter
Type
Description
minProgress
integer
The required score to reach the level.
order
integer
Level Order
icon
string
icon URL of the level.
name
string
Level Name
benefits
object
"benefits":{
"rankReward":0,
"walletReward":0,
"levelDiscount":0,
"discountCapping":0,
"others":[]
}
The benefits object is defined as follows:
rankReward: Score rewarded upon reaching that level.
walletReward : Points rewarded upon reaching that level.
levelDiscount: The discount amount that the level grants.
discountCapping: The maximum value to which the discount is applicable.
Example: 10% discount for maximum order price 100 USD
others: An array of statement(s) that can be used to describe the benefits of the level.
challenge Object
Parameter
Type
Description
id
integer
Unique identifier for the challenge.
name
string
Challenge Name
description
string
Challenge Description
rankReward
integer
Awarded rank upon challenge completion
walletReward
integer
Awarded points upon challenge completion
repeatable
boolean
A flag that indicates whether the challenge is repeatable or not.
maxAchievement
integer
An integer that defines how many times a player can achieve that challenge.
type
string
The type of the challenge. Possible values are as follows:
SignUp
SocialMedia
ScheduledChallenge
EventBased
HighScore
Birthday
Anniversary
visibility
string
Defines the visibility of the challenge. Possible values are:
"AlwaysVisibile"
"NotVisible"
"VisibleIfEarned"
icon
string
The icon's URL of the challenge.
availability
object
"availability":{
"minLevel": 4,
"tags": ["VIP"]
}
An object that describes challenge availability to players.
minLevel : Minimum required level for the player to be eligible to the achieve the challenge.
tags: Array of tags for which the challenge is available.
referral Object
Parameter
Type
Description
referralMethod
string
Defines how the referral program rewards your players, Possible values:
"PlayerAndFriend" denotes that both the referring and the referred player should be rewarded. The referred player also should complete the sign up process and perform a certain action according to your configurations.
"PlayerOnly" denotes that only the referring player that should be rewarded after a successful referral.
"PlayerAndGuest" denotes that both the referring and the referred player should be rewarded. Referred Player Registration is optional, but he would be rewarded after placing a successful order.
eventName
string
The name of the event which is linked to the referral action
eventMetaData
string
The event metadata which value should be monitored and checked for completing the referral.
playerReward
object
"playerReward":{
"extraReward":{
"rewardEvery":5,
"rewardType":null,
"score":2,
"point":1,
"voucher":null
},
"rewardType":"Vouchers",
"score":0,
"point":0,
"voucher":{
"voucherType":"Free Shipping",
"productId":"",
"productName":"",
"value":0
}
}
An object that defines the referring player's reward.
The playerRewardobject is defined as follows:
extraReward: An object that defines the extra reward the referring player is granted after completing specific number of referrals.
"extraReward":{
"rewardEvery":5,
"rewardType":null,
"score":2,
"point":1,
"voucher":null
}
rewardEvery:Defines the frequency upon which the referring player is rewarded
rewardType : Defines the type of the reward, possible values are:
"Vouchers"
"Score&Points"
score: Score rewarded as an extra reward.
points: Points rewarded as an extra reward.
voucher: An object that defines the rewarded voucher.
"voucher":
{
"voucherType":"Free Product",
"productId":"6161866621123",
"productName":"Antique Drawers",
"value":250
}
rewardEvery:Defines the frequency upon which the referring player is rewarded
rewardType : Defines the type of the reward, possible values are:
"Vouchers"
"Score&Points"
score: Score rewarded as an extra reward.
points: Points rewarded as an extra reward.
voucher: An object that defines the rewarded voucher.
friendReward
object
Defines the referred player reward configurations in case the referralMethod is "PlayerAndFriend" meaning that the referred player should also be rewarded.
The object is the same as the playerReward object excluding the extraReward.
cashback Object
Parameter
Type
Description
rewardFactor
number
In case you have different merchants (brands) on your platform, The rewardFactor defines the specific cashback percentage for the paid amount to be rewarded to your players.
Example: If you give 5% cashback (when the customer pays 100 USD, they will get 5 USD cashback). The rewardFactor would be 0.05
amountRewardThreshold
integer
Defines the amount of unit currencies needed to reward the player as per cashback rules.
Example: For every 10 USD spent the player gets rewarded by 5 points, implies that the amountRewardThreshold is "10".
rewardWalletFactor
integer
Determines the points rewarded for each unit currency your player spends.
Example: 2 points for every 1 USD spent, implies that the rewardWalletFactor is "2"
rewardRankFactor
integer
In case your level up method is score, this factor determines the score rewarded for each unit currency your player spends.
Example: 2 Score for every 1 USD spent, implies that the rewardRankFactor is "2"