Player Progress

Show your players their progress in the loyalty program

This endpoint allows you to retrieve specific player details with the corresponding current progress in Gameball programs.

This endpoint is only available for our GURU customers only

GET /integrations/player/:playerUniqueId/progress

Path Parameters

Name	Type	Description
playerUniqueId	string	Player unique identifier used to uniquely identify the player on Gameball

Headers

Name	Type	Description
APIKey	string	Client APIKey

200

{
    "player": {
        "dateOfBirth": null,
        "communityId": null,
        "rankPoints": 0,
        "points": 0,
        "referralCode":"CCDD123",
        "tags":[
            "VIP"
        ],
        "progress":
        {
            "levels":{
                "current":{
                    "order":1,
                    "name":"level 1",
                    "icon":"",
                    "minPorgress":0
                },
                "next":{
                    "order":2,
                    "name":"level 2",
                    "icon":"",
                    "minPorgress":2000
                }
            },
            "challenges": [
                {
                    "id": "123",
                    "name": "Welcome",
                    "isUnlocked": true,
                    "highScoreAmount": null,
                    "completionPercentage": 0,
                    "achievedCount": 0
                },
                {
                    "id": "p123",
                    "name": "Place Order",
                    "isUnlocked": true,
                    "highScoreAmount": null,
                    "completionPercentage": 55,
                    "achievedCount": 2
                }
            ],
            "referrals": {
                "totalReferredPlayers": 0,
                "totalRewardPoints": 0
            }
        }
    }
}