Create a Leaderboard

Leaderboards are used to show a user or group how they rank in relation to other users or groups. You can create leaderboards that track user or group actions, points, or mission completions.

Note: If you delete a leaderboard, any layouts that use that leaderboard are also deleted.

Create the Leaderboard Structure

  1. Open Nitro Studio > Motivate > Leaderboards.
  1. Click New and select the leaderboard type:
    • Actions - Shows leaders based on actions logged.
    • Missions - Shows leaders based on missions completed.
    • Points - Shows leaders based on points earned.
  1. On the New Leaderboard page, define the leaderboard settings:

    Field

    Description

    Name

    The leaderboard name.

    Description

    The description of the leaderboard.

    Party type

    The type of action the leaderboard should listen for:

    • User - Actions logged for a user with the POST /users/{userId}/actions API.
    • Group - Actions logged for a group with the POST /groups/{groupId}/actions API.
    • Aggregate - Actions logged by users and aggregated into a rollup of points/actions/missions within a group.

    Duration

    Select how far back totals are calculated. Calculations are based on the selected timezone.

    Ranking is based points, action values, or missions depending on the leaderboard type.

    • Day - Shows ranking earned from 12:00am on the current date.
    • Week - Shows ranking earned from 12:00am on the Sunday from the week of the current date.
    • Month - Shows ranking earned from 12:00am on the first day of the month of the current date.
    • Quarter - Shows ranking earned from 12:00am of the first day of the month selected in the Quarter Starts On field. The leaderboard runs for 90 days.
    • Year - Shows ranking earned from 12:00am on the first day of the month selected in the Year Starts On field. The leaderboard runs for 12 months.
    • All time - The date is ignored.

    Quarter/Year Starts On

    For quarterly and yearly duration leaderboards, select the leaderboard's starting month. If not set, defaults to the current month.

    Timezone

    Select the leaderboard's timezone. The timezone is important for duration based leaderboards as the daily/weekly/monthly reset should occur in the timezone where your users are located.

    Action

    For Actions leaderboards, select the action you want to track. Currently leaderboards only support one action per leaderboard.

    Point Category

    For Points leaderboards, select the point category for the points you want to track.
  1. Click Save.
  2. To display the leaderboard to users, create a leaderboard layout using one of the following methods:

See also

Blocks

Web components

Styling web components