🎮Gamification
Information about gamification integration APIs and how to interact with them.
Our integration REST API has the following endpoints:
Endpoint | Type | Description |
---|---|---|
| Returns available challenges for specific users. | |
| Returns challenges that user has progress on, with each challenge details. | |
| Returns challenges with reward type badge for the user. | |
| Returns challenges history for user including previously won rewards. | |
| Returns challenge details for specific user. | |
| Returns badge challenge details for specific user. | |
| Returns available challenges categories. | |
| Add user progress to the given trigger. | |
| Updates the milestone state for the user, changes claimed to unclaimed, and vice versa. |
For all APIs. the response is unified as follows:
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.
Last updated