🎮Gamification

Information about gamification integration APIs and how to interact with them.

Our integration REST API has the following endpoints:

Endpoint	Type	Description
GetChallengeInfoForUser	GET	Returns available challenges for specific users.
GetProgressChallengesInfoForUser	GET	Returns challenges that user has progress on, with each challenge details.
GetBadgeChallenges	GET	Returns challenges with reward type badge for the user.
GetChallengeHistoryForUser	GET	Returns challenges history for user including previously won rewards.
GetDetailsById	POST	Returns challenge details for specific user.
GetBadgeDetailsById	POST	Returns badge challenge details for specific user.
GetChallengeCategories	GET	Returns available challenges categories.
AddAction	POST	Add user progress to the given trigger.
UpdateIsClaimed	PUT	Updates the milestone state for the user, changes claimed to unclaimed, and vice versa.

For all APIs. the response is unified as follows:

{
  "result": {
    "data": [ ],
    "pagesNum": 1,
    "count": 1
  },
"message": "Process completed successfully",
"statusCode": 1,
"statusName": "Successfully"
}

• result (object): Contains the data and metadata for the API response.

• data (List): List of objects retrieved by the request.

• pagesNum (int): The current page number of the results.

  • Example: 1

• message (string): A message indicating the result of the API call.

  • Example: "Process completed successfully"

• StatusName (string): An indicator for the status code.

  • Example: "successfully"

More details about each API are provided in the next sections.