Create a Custom User Experience

Bunchball highly recommends using blocks or Impact+ to create a gamification program. However, if your program calls for advanced functionality or custom designs beyond what is achievable with our blocks and themes, you can build a custom user experience with APIs.

You can find API documentation here: https://api.bunchball.com/docs

Gamification Element

API Methods

Events

GET /events

Leaderboard

  • GET /leaderboards/{leaderboardId}/leaders - returns multiple leaders
  • GET /leaderboards/{leaderboardId}/leaders/{userContextId} - returns a single leader

Missions

  • GET /users/{userId}/challenges - returns a user's missions
  • GET /users/{userId}/challenges/{challengeId}/progress - returns a user's progress within a specific mission
  • GET /groups/{groupId}/challenges - returns a group's missions
  • GET /groups/{groupId}/challenges/{challengeId}/progress - returns a group's progress within a specific mission

On The Spot Card Redemption

POST /users/{userId}/award-ots

Profile

  • GET /users/{userId}/at-a-glance - returns a summary of a user's activity
  • GET /users/{userId}/points - returns a user's points
  • GET /users/{userId}/preferences - returns a user's image, name, and role
  • GET /users/{userId}/levels - returns the user's current and next level

For award account programs:

  • GET /users/{userId}/award-catalog - Get a catalog URL where the user can sign in to redeem points
  • GET /users/{userId}/award-balance - Get the user's award account balance available for redemption
  • GET/user/{userId}/award-verification - Get the user's verification status if necessary to display a custom message

Quiz

  • GET /users/{userId}/quizzes - returns the user's quizzes
  • GET /users/{userId}/quizzes/{quizId}/questions - returns a list of quiz questions
  • GET /users/{userId}/quizzes/{quizId}/questions/{questionId}/responses - returns the user's responses to quiz questions

Recognitions

  • GET /users/{userId}/exchanges - returns the exchanges a user is eligible for
  • GET /users/{userId}/exchanges/{exchangeId} - returns a specific exchange
  • GET /users/{userId}/exchanges/{exchangeId}/categories - returns the categories within an exchange
  • GET /users/{userId}/exchanges/{exchangeId}/points - returns a user's points budget for a specific exchange
  • GET /users/{userId}/exchanges/{exchangeId}/recipients - returns the available recipients for a specific exchange
  • GET /users/{userId}/interactions-collection - returns the recognitions given and/or received by the user
  • POST /users/{userId}/interactions-collection - logs the recognitions a user gives to other users

Trophy Case

GET /users/{userId}/badges

See also

Blocks

APIs