Users

Users are the people engaged in your program. They complete activities and missions, compete on leaderboards, earn and spend points, and so on.

An active user is a unique user that has logged an action in Nitro within a quarter. To determine the number of active users for an annual subscription, active users in each quarter are compared over the period of a year. The quarter with the highest number of active users determines your active user count. This number cannot go down, although active users can be different individuals in each quarter. Show me an example

	Who logged an action?	Quarterly active user count	Annual active user count
Q1	10k unique users	10k	10k
Q2	8k of the same users from Q1 and 2k new unique users	10k	10k
Q3	9k of the same users from Q1 and Q2 and 3k new unique users	12k	12k
Q4	10k of the same users from Q1, Q2, and Q3	10k	12k

Nitro User ID

Nitro does not store any personal user information, only the unique identifier you use to represent the user. If users are interacting with your program from different applications, ensure that you use the same identifier to represent each user, no matter what platform they're using.

The user ID is used to make API calls, so choose an identifier that you always have access to wherever you need to make a call. This may be the user's GUID, username, or email. The identifiers you don't choose as the user ID can be stored as preferences. Two special preferences, named "firstName" and "lastName", are returned with most API calls that return lists of users. You can use these preferences to store the user's name, email address, or other data. The preferences are two custom data preferences that you can use however you want knowing that they will be passed back to you when you get lists of user IDs.

View User Information

There may be a small time lag between the creation of a user and when they show up in Nitro searches.

Open Nitro Studio > Activity > Users.
Scroll through the list, or enter a user ID or name in the Search field.
Click a user to view their details.

Award Account Tab

Displays the user's Award Account properties.

Field	Description
Enrollment	Shows if the user is enrolled in the Award Account. Click Enroll to manually enroll the user.
Country Code	The country where the user is located. The country code is set when you enroll the user and is used to direct the user to the catalog where they can spend their award points.
Verification	Click to manually verify or unverify the user. Depending on the verification options set in your award account, a user's enrollment and verification status determines if they can earn award points, see award points in the Missions web component, view their available balance, and spend award points.
Balance	The user's remaining redeemable point balance. Points are debited when the user purchases from the Global Rewards Marketplace.

Balances Tab

Displays the user's point balances and activity.

Section	Description
Balances by Point Category	The user's point balance totals from all point categories. Note: The award account point category only displays if the user is enrolled in the award account. Click Edit () to manually change the user's point balance. Learn more about how editing points may impact leaderboards. In the Adjustment Type section, select Credit or Debit. In the Amount field, enter the number of points you want to credit or debit. If necessary, clear the Update Lifetime Balance option. A user's Lifetime balance is used in leaderboards and levels, while the Current balance is their spendable amount. Clear this option if you want to change a user's balance without impacting leaderboards and levels. For non-award programs, the lifetime and current balance are typically the same amount. A user has three balances: Current Balance - what they've earned minus any admin debits/reversals. Lifetime Balance - what they've earned throughout their life in the program. Manual point balance changes can optionally update the lifetime balance. Award Account Balance - (Reward Points Only) the Rewards Marketplace balance which includes any reward redemptions. Since Nitro does not store merchandise redemption information, this balance may be different (lower) than the current or lifetime balance from program earnings stored in Nitro. In the Tags field, add a description of the change. The description displays in the Activity section. If necessary, select Edit Bill Codes and override global bill codes for this transaction. This option is only available for the point category linked to your award account. Note: Bill code information will only show if you have global values that can be overridden. Click Save.
Activity	The activities associated with earning or losing points. Click Filter by Point Category to narrow the list of results.

Section

Description

Balances by Point Category

The user's point balance totals from all point categories. Note: The award account point category only displays if the user is enrolled in the award account.

Click Edit ( Edit Button ) to manually change the user's point balance. Learn more about how editing points may impact leaderboards.

In the Adjustment Type section, select Credit or Debit.
In the Amount field, enter the number of points you want to credit or debit.
If necessary, clear the Update Lifetime Balance option. A user's Lifetime balance is used in leaderboards and levels, while the Current balance is their spendable amount. Clear this option if you want to change a user's balance without impacting leaderboards and levels. For non-award programs, the lifetime and current balance are typically the same amount.
A user has three balances:

Current Balance - what they've earned minus any admin debits/reversals.
Lifetime Balance - what they've earned throughout their life in the program. Manual point balance changes can optionally update the lifetime balance.
Award Account Balance - (Reward Points Only) the Rewards Marketplace balance which includes any reward redemptions. Since Nitro does not store merchandise redemption information, this balance may be different (lower) than the current or lifetime balance from program earnings stored in Nitro.

In the Tags field, add a description of the change. The description displays in the Activity section.
If necessary, select Edit Bill Codes and override global bill codes for this transaction. This option is only available for the point category linked to your award account.

Note: Bill code information will only show if you have global values that can be overridden.

Click Save.

Activity

The activities associated with earning or losing points. Click Filter by Point Category to narrow the list of results.

Actions Tab

Displays the actions logged by the user.

Column	Description
Tags	The name of the logged action.
Value	The action value sent with the action.
Metadata	The metadata sent with the action.
Action Time	The time the action occurred.
Create Time	The time the action was logged in Nitro. If the action is not backdated, the actionTime and createTime should be the same or seconds apart.
Event ID	The unique ID associated with the action. If a value is not set in the eventId parameter when logging the action via API, a generic ID will be created.

Missions Tab

Displays the user's available and completed missions. The order missions appear in the Eligible Missions section matches the order they will appear to the user in the Missions web component.

Scenario	Method
Open a mission in the Mission Management view	Click the mission name link.
Manually award a mission to the user	In the Eligible Missions list, click the award icon ().
Remove a mission award from the user	In the Completed Missions list, click the remove mission icon (). When you remove the completion of a repeatable mission, it removes the last recorded completion, then the previous completion, and so on until all completions are removed. If the mission awards points, the corresponding points are debited from the user account. Learn more about how removing a mission may impact leaderboards.

Scenario

Method

Open a mission in the Mission Management view

Click the mission name link.

Manually award a mission to the user

In the Eligible Missions list, click the award icon ( Award Challenge Icon ).

Remove a mission award from the user

In the Completed Missions list, click the remove mission icon ( Remove Challenge Icon ). When you remove the completion of a repeatable mission, it removes the last recorded completion, then the previous completion, and so on until all completions are removed.

If the mission awards points, the corresponding points are debited from the user account. Learn more about how removing a mission may impact leaderboards.

Groups Tab

Displays a list of the groups the user is a member of.

Click a group to open it in the Group Management view.
Click Delete () to remove the user from the group.

Preferences Tab

Displays the user's preferences. Preferences can be managed on this tab, with data import, or with the PUT /users/{userId} API.

Click New to add a preference.
Click Edit () to change the value of an existing preference.
Click Delete () to delete the preference.

Change Log Tab

Displays group, preference, level, and other user changes. Click Add Filter and select a change type to filter the list of results.