June 2024 Release

Production Release Date: June 26

REST APIs

The following API change is documented on https://api.bunchball.com/docs.

POST /users/{userId}/quizzes/{quizId}/submit - Updated to include three new parameters:
- totalCorrect - Returns the total number of questions the user answered correctly.
- totalQuestions - Returns the total number of questions in the quiz.
- percentCorrect - Returns the user's completion score for the quiz rounded to the nearest integer.
GET /users/{userId}/challenges and groups/{groupId}/challenges - Updated to include the showLegacyLockedReasons parameter. When true, the response for locked missions includes the reasons and prereqs attributes which define the mission's prerequisite details. When false, the response only includes the prereqs attribute. We recommend all programs set this parameter to false as the reasons array is scheduled for deprecation.
GET /users/{userId}/challenges - Updated the response to return an empty object when no missions are returned on the specified page. Previously it would return the same mission(s) from prior pages.
GET /leaderboards/{leaderboardId}/leaders - Updated to enforce a pageSize of 100 records or less.
The following methods are no longer considered Experimental and are available for use:
- GET /users/{userId}/at-a-glance - Returns a summary of the user's activity including their last point transaction, level, badges, and last completed mission.
- GET /users/{userId}/leaders/{layoutUuid} - Returns the users in a leaderboard and the user's position in the leaderboard. The user's position is only returned if the user's rank is within the leaderboard return count.
- GET /users/{userId}/ranked-challenges - Returns the missions a user is eligible for in the order defined by the mission recommendation engine.

Product Updates

Nitro Impact BETA Release

We're excited to announce the beta release of Nitro Impact! Impact is a comprehensive gamification dashboard that's easily embeddable on your website. It showcases missions, leaderboards, quizzes, and more in one visually appealing block.

Impact is designed to be desktop and mobile responsive, stylable to match your brand standards, and supports imagery that will help engage your users.

Impact is now available for beta testing! Contact Bunchball Support if you're interested in beta testing Impact.

Nittro Impact Example

QUIZ_COMPLETED Action Metadata and Value

The information sent to Nitro when a user completes a quiz was updated to include additional quiz data. Quizzes/Surveys/Polls send the QUIZ_COMPLETED action which now includes the following information in the metadata:

totalCorrect - Returns the total number of questions the user answered correctly.
totalQuestions - Returns the total number of questions in the quiz.
percentCorrect - Returns the user's completion score for the quiz rounded to the nearest integer.

In addition, the percent correct is returned as the action value. The action value can be used in missions to reward a user based on their quiz score. You can view action information on the Actions tab in the Users view.

Action Metadata Example

Metadata Case-Insensitivity

To help simplify mission configurations that include metadata, the metadata Name and Value will now be case-insensitive. When you add metadata to the mission's rule, Nitro will ignore case and complete the action if the metadata Name and Value match.

Default Metadata in Self-Reporting Rules

Metadata ensures that when a user marks a self-reporting task as complete, it will only complete that mission and not all missions that have a self-reporting rule using the same action (although it may complete or make progress on missions that use the same action with no metadata).

To simplify the administration of self-reporting rules, Nitro now automatically adds and updates metadata when you save the rule. The default metadata includes:

nitro-self-reporting:true
selfReporting:{missionId_ruleId}
rule_Url:{ruleUrl}

The rule URL is only added if a URL exists for the rule, it does not add metadata for subtask URLs.

Self-Reporting Rule Metadata Example

Upcoming API Deprecation

Effective with the August 2024 release, we will deprecate and remove the following parameter from the platform. Update any code that uses this parameter in advance of the August release.

GET /users/{userId}/challenges - We will deprecate the value parameter in the rewards section of the response. Update any code that references the value parameter to use the pointAward parameter.