From the Reports Module you can generate and save performance reports on several aspects of your Nitro deployment.

 

The Rewards Module consists of one or more Reports Pages, represented by the tabs along the top.  By default, your site may have several pages and reports preconfigured for you, or there may just be one page called "New Page".  On each Page, you can add one or more Reports.  Reports can show you information (graphs or text) about some measurable aspect of Nitro, such as the total number of users, or the average number of actions logged per user.

 

---

 

Reports Pages

 

Pages are a convenient way to organize your reports.  You can access your various pages by using the tabs along the top of module. 

 

Managing Pages

• You can add a new page by using the Add button.
• You can remove a page by using the Remove button.
• You can rename a page by using the Rename Page button (located on the page itself).

 

Saving

Use the Save button to save all the pages and reports you've created and laid out.  The next time you use the Admin UI, you'll see the same layout and report configurations.  The button will enable itself whenever you've made a change to any of your pages or reports.

 

Dates

For each page, you can set a date range that will be applied to all the reports on the page. 

• You can choose a From date in terms of Today, or X number of days ago relative to today, or an exact date.
• You can choose a To date in terms of Today, or X days after the From date, or an exact date.
• You can choose to group your report data by Day, Week, Month, Year or treat the entire date range as one group (ALL).
• After changing the date options, click the Refresh button to re-fetch your reports for the new dates.

 

---

 

Reports

 

A report is a set of data about a particular aspect of your Nitro deployment.  Some examples of reports are:

• Show me the total number of users each week
• Show me the top ten actions logged last month
• Show me the average number of points awarded per user since I started using Nitro
• Show me top 3 users in terms of tasks completed, each week

 

Adding a Report

To add a new report to a page, click the Add Report button.  You will see the Configure Report dialog.  You can set the following properties for the report:

• Metric - the kind of information you want:
  • New Users - the number of users who were created
  • Total Users - the total number of users that existed as of a particular date (sum of all new users to date)
  • Points Awarded - the total number of points that were credited
  • Points Spent - the total number of points that were debited
  • Points Change - the total change in points (credits - debits) that occurred
  • Points Balance - the total points balance as of a particular date (sum of all points changes to date)
  • Total Actions - the total number of actions that were logged
  • Actions Value - the total value of all the actions that were logged
  • Challenges Completed - the number of challenges that were completed
  • API Usage - the number of Nitro API calls sent to the server (new in 1.8: does not include user.login or user.logout in totals, so better reflects what is relevant to pricing)
• Operator - how you want the metric to be returned
  • Sum - the total value (as it is described in the Metric definitions)
  • Average Per User - the total value divided by the number of total users that existed
• List Type - how you want the data organized in terms of users/tags/actions/challenges/methods
  • None - just show the total value across all users/tags/actions/challenges/methods
  • Top Filters - show the values organized by the top X filters.  A filter is either a tag (for the Points metrics and Actions metrics - can also be an action tag) or a challenge name (for Challenges Completed, or an API method name (for API Usage)
• Return Count - if you're using Top Filters, the Return Count specifies how many users/tags/actions/challenges to show data for
• Filters - you can optionally enter a comma-separated list of filters to only get data for those filters, grouped and ranked.  If you use Top Filters as well, you will only get the top X filters out of the filter list you specified, where X is the Return Count.  A filter is either a tag (for the Points metrics and Actions metrics - can also be an action tag) or a challenge name (for Challenges Completed, or an API method name (for API Usage).  New in 1.8: you can now use wildcards (*) in the filter list.  For example, you can get all tags that match 'PLAY_*', which would get you all the tags that start with 'PLAY_'.
• Dates and Date Grouping - by default, a report will use the same date range and date grouping as its containing page.  If you want, however, you can create reports that offset either the start date or end date by a given number of days, of specify exact dates to use.  You can also override the date grouping (Days, Weeks, Months, Year, or All).

 

Finally, click the Done button, and your report will be added to the page and run.

 

Hiding/Showing Filters (new in 1.8)

With a filtered report that is a line chart, you can hide and show filters by clicking on their names in the Legend at the bottom of the report.  The report's axis range will automatically adjust to fit the shown content.  This is useful if one filter is throwing off the scale of the report, making it hard to see the others.  You can also click on a data point in the report itself to show only that line.  Double-click anywhere to show all the lines again.

 

Changing a Report

You can change the page's date range or grouping, and re-run the reports on the page by clicking Refresh.  If you want to change anything about the report, you can use the report's Edit button.  Note that if a report is using its own dates, changing the page's dates won't affect the report.

 

Report Format

The report will either show as a line chart (if there are multiple date groups to show), or a bar chart (if there is only one date group), or a single value (if there is only one date group and no user/filter grouping).

 

Laying out Reports

Next to the Edit button, there are three small buttons that can be used to move around reports on a page.  You can use the two buttons on the left to move a report up or down.  You can use the bigger button on the right to change which column a report is in.  This can be used to show reports next to each other horizontally.  Each report can belong to either the left of right column. 

 

Removing a Report

You can use the X button to remove a report from the page. 

 

---

 

Exporting

 

You can export your reports as either CSV (comma-separated values that can be imported into programs like Excel), or as images (PNGs). 

 

To export a single report (CSV or image), click the report's Export button, and in the resulting dialog, use either the Copy CSV Data to Clipboard button to copy the data to your system clipboard, or the Save Graph Image button to save an image of the report to your computer. 

 

To export a page of reports (image only), use the page's Export All button.