deprecated: method names will be continued to be supported, but customers are encouraged to migrate to the new method names.

whitelisted: the IP address of your server needs to be in the whitelist. Can be done from Admin UI.

 

Challenges

user.logAction          (user.logEvent deprecated)       whitelisted

Sends an action to the Nitro Server.

user.getResponses   (new in 1.8)

Gets any user.logAction responses that were stored.

user.getChallengeProgress  

          Gets a user's current status for all challenges on a site.

user.getActionHistory       (user.getEventHistory deprecated)

          Returns a user's history of actions logged. 

site.getActionFeed            (site.getEventFeed deprecated)

          Returns the most recent actions logged and challenges achieved for a site.

site.getActionStats    (site.getEventStats deprecated)

          Returns a site-wide leaderboard based on the number or values of actions logged.

site.getChallengeStats

          Returns a site-wide leaderboard based on the number of challenges completed, or the most progress made on a specific challenge. 

site.getRecentActions  (site.getRecentEvents deprecated)

          Returns the most recent actions logged on a site, or the users who've logged a specific action in reverse chronological order.

site.getRecentChallenges

          Returns the most recent challenges completed on a site, or the users who've completed a specific challenge in reverse chronological order.

 

 

Comments

user.getComments

     Returns a user's sent and received messages.

user.getSavedCommentCount

     Returns the number of messages a user has sent.

user.saveComment

      Stores a user-to-user message.

 

Levels

user.getLevel

     Gets the user's current level.  Works for either points-based leveling or custom leveling.

user.getNextLevel

     Gets the level after the user's current level in a site's level list.  Works for either points-based leveling or custom leveling.

user.setLevel          whitelisted

Sets the user's level.  Only valid when a site is using custom-leveling (as opposed to points-based leveling).

site.getLevelList

     Gets all the levels for a site.

 

User Management

user.login

Logs a user in.

user.logout

Logs a user out. 

user.modifyUserId            whitelisted

Changes the id of a user to a brand new value 

user.transferPoints           whitelisted       

Transfers the point balance, points history and action history of one user to another

 

Points

user.getPointsBalance          (point.balance deprecated)

 Returns the point balance for the specified user.

user.creditPoints          (point.credit deprecated)          whitelisted

Credits points to a user.

user.debitPoints          (point.debit deprecated)          whitelisted

Debits points from a user.

user.getPointsHistory          (point.history deprecated)

Returns a user's point accumulation history.

user.releasePoints          whitelisted

Release points that were previously reserved.

user.reservePoints          whitelisted

Reserves some points in "escrow". 

site.getPointsLeaders

Returns the point leaders. 

 

Preferences

user.getPreference

     Gets a user preference.

user.getPreferences

     Gets all the preferences for a given user.

user.setPreference           whitelisted

Sets a single user preference.

user.setPreferences           whitelisted

Sets multiple user preferences.

 

 

Utility

batch.run

Execute multiple methods in one request.

system.serverStatus

Checks if the server is up.

hello

Pings the server