How To Build A Leaderboards Feature

The guide outlines the full process of adding a leaderboards feature to your web or mobile app using Trophy. For illustration purposes we’ll use the example of a study platform that uses a daily leaderboard to create friendly competition around viewing flashcards.

To see a fully working example of this in practice, check out the live demo or github repo.

Pre-requisites

A Trophy account
About 10 minutes

Trophy Setup

In Trophy, Metrics are the building blocks of gamification and model the different interactions users make with your product. In this guide the interaction we’re interested in is flashcards-viewed, but you can create a metric that best represents the interaction you want to build leaderboards around. In the Trophy dashboard, head to the metrics page and create a metric.

Once you’ve created your metric, head to the leaderboards page and create the leaderboards you want. You can find all the details on the types of leaderboards and the different use cases in the leaderboards docs.

For the purposes of this guide we’ve set up a daily leaderboard that tracks the total XP a user earns by viewing flashcards.

For a full guide on adding an XP feature to your web or mobile app, check out our full guide.

In Trophy you track user interactions by sending Events from your code to Trophy APIs against a specific metric. When events are recorded for a specific user, Trophy automatically updates their ranking in each leaderboard they are a part of. This is what makes building gamified experiences with Trophy so easy, it does all the work for you behind the scenes.

Installing Trophy SDK

To interact with Trophy from your code you’ll use the Trophy SDK available in most major programming languages. Install the Trophy SDK:

npm install @trophyso/node

gem install trophy_api_client

pip install trophy

composer require trophyso/php

implementation 'so.trophy:trophy-java:1.0.0'

<dependency>
  <groupId>so.trophy</groupId>
  <artifactId>trophy-java</artifactId>
  <version>1.0.0</version>
</dependency>

go get github.com/trophy-so/trophy-go

// .NET Core CLI
dotnet add package Trophy

// Nuget Package Manager
nuget install Trophy

// Visual Studio
Install-Package Trophy

Next, grab your API key from the Trophy integration page and add this as a server-side only environment variable.

TROPHY_API_KEY='*******'

Make sure you don’t expose your API key in client-side code.

Tracking User Interactions

To track an event (user interaction) against your metric, use the metric change API.

curl -X POST https://api.trophy.so/v1/metrics/flashcards-flipped/event \
     -H "X-API-KEY: <apiKey>" \
     -H "Idempotency-Key: flashcard-view-42" \
     -H "Content-Type: application/json" \
     -d '{
  "user": {
    "id": "18",
    "email": "user@example.com",
    "tz": "Europe/London"
  },
  "value": 750
}'

import type { EventResponse } from "@trophyso/node/api";

const response: EventResponse = await trophy.metrics.event(
  "flashcards-flipped",
  {
    user: {
      id: "18",
      email: "user@example.com",
      tz: "Europe/London",
    },
    value: 750,
    idempotencyKey: "flashcard-view-42",
  }
);

client.metrics.event(
    key="flashcards-flipped",
    user=EventRequestUser(
        id="18",
        email="user@example.com",
        tz="Europe/London",
    ),
    value=750.0,
)

$user = new EventRequestUser([
    'id' => '18',
    'email' => 'user@example.com'
]);

$request = new MetricsEventRequest([
    'user' => $user,
    'value' => 750
]);

$trophy->metrics->event("flashcards-flipped", $request);

MetricsEventRequest request = MetricsEventRequest.builder()
      .user(
        EventRequestUser.builder()
          .id("18")
          .email("user@example.com")
          .build()
      )
      .value(750)
      .build();

EventResponse response = client.metrics().event("flashcards-flipped", request);

response, err := client.Metrics.Event(
    "flashcards-flipped",
    &api.MetricsEventRequest{
        User: &api.EventRequestUser{
            Id: "18",
            Email: "user@example.com",
        },
        Value: 750,
    },
)

var user = new EventRequestUser {
   Id = "18",
   Email = "user@example.com"
};

var request = new MetricsEventRequest {
   User = user,
   Value = 750
};

await trophy.Metrics.EventAsync("flashcards-flipped", request);

result = client.metrics.event(
  :key => 'flashcards-flipped',
  :user => {
    :id => '18',
    :email => 'user@example.com'
  },
  :value => 750
)

The response to this API call is the complete set of changes to any features you’ve built with Trophy, including any changes to their ranking in any leaderboards they are a part of.

Response

{
  "metricId": "d01dcbcb-d51e-4c12-b054-dc811dcdc623",
  "eventId": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
  "total": 750,
  ...,
  "leaderboards": {
    "daily_champions": {
      "id": "0040fe51-6bce-4b44-b0ad-bddc4e123535",
      "key": "daily_champions",
      "name": "Daily Champions",
      "description": null,
      "rankBy": "metric",
      "runUnit": null,
      "runInterval": 0,
      "maxParticipants": 100,
      "metricName": "Flashcards Flipped",
      "metricKey": "flashcards-flipped",
      "threshold": 10,
      "start": "2025-01-01",
      "end": null,
      "previousRank": 50,
      "rank": 12
    }
  }
}

Validate this is working by checking the Trophy dashboard.

Displaying Leaderboards

You have a number of options for displaying leaderboards in your application. Here we’ll look at the most common options.

Pop-up Notifications

We can use the response of the metric change API to show pop-up notifications (or ‘toasts’) when users move up the rankings. Here’s an example of this in action:

Leaderboard Rank Up Pop-up

// Sends event to Trophy
const response = await viewFlashcard();

if (!response) {
  return;
}

const leaderboard = response.leaderboards["daily_champions"];

if (!leaderboard) {
  return;
}

// Show toasts if the user moved up the leaderboard
if (leaderboard.rank > leaderboard.previousRank) {
  toast({
    title: "You're on the move!,
    description: `You moved up ${leaderboard.previousRank - leaderboard.rank} places!,
  });
}

If you want to play sound effects, use the HTML5 Audio API and feel free to steal these audio files we recommend.

Displaying Leaderboard Rankings

To fetch a leaderboard and its most up to date rankings, use the leaderboard API.

curl --request GET \
  --url https://api.trophy.so/v1/leaderboards/{key} \
  --header 'X-API-KEY: <api-key>'

trophy.leaderboards.get("daily_champions", {
  offset: 0,
  limit: 10,
  run: "2025-01-15"
});

client.leaderboards.get(
    key="daily_champions",
    offset=0,
    limit=10,
    run="2025-01-15"
)

$trophy->leaderboards->get("daily_champions");

client.leaderboards().get("daily_champions");

response, err := client.Leaderboards.Get("daily_champions")

trophy.Leaderboards.GetAsync("daily_champions");

result = client.Leaderboards.Get(
  :key => "daily_champions"
)

You can also use the run parameter with the date of the specific past ‘run’ of a leaderboard you want to fetch data for.

Here’s an example of the data returned from the leaderboard API:

Response

{
  "id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
  "name": "Weekly Flashcard Challenge",
  "key": "weekly-challenge",
  "rankBy": "metric",
  "metricKey": "flashcards-flipped",
  "metricName": "Flashcards Flipped",
  "pointsSystemKey": null,
  "pointsSystemName": null,
  "description": "Compete weekly to see who views the most flashcards",
  "status": "active",
  "start": "2025-01-01",
  "end": null,
  "maxParticipants": 100,
  "runUnit": "day",
  "runInterval": 7,
  "rankings": [
    {
      "userId": "user-123",
      "userName": "Alice Johnson",
      "rank": 1,
      "value": 5000
    },
    {
      "userId": "user-456",
      "userName": "Bob Smith",
      "rank": 2,
      "value": 4500
    },
    {
      "userId": "user-789",
      "userName": "Charlie Brown",
      "rank": 3,
      "value": 4200
    }
  ]
}

Displaying User Rank History

Use the user leaderboard API to fetch data on how a specific user’s rank has changed over time in a particular leaderboard.

curl --request GET \
  --url https://api.trophy.so/v1/users/{id}/leaderboards/{key} \
  --header 'X-API-KEY: <api-key>'

trophy.users.leaderboards("user-id", "daily_champions", {
  run: "2025-01-15"
});

client.users.leaderboards("user-id", "daily_champions", run="2025-01-15")

$trophy->users->leaderboards("user-id", "daily_champions")

client.users().leaderboards("user-id", "daily_champions")

response, err := client.Users.Leaderboards("user-id", "daily_champions")

trophy.Users.Leaderboards("user-id", "daily_champions");

result = client.Leaderboards.Get(
  :id => "user-id",
  :key => "daily_champions"
)

Here’s an example of the data returned from the user leaderboard rankings API which includes the users current rank in the rank attribute and an array of previous ranks in the history attribute:

Response

{
  "id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
  "name": "Weekly Word Count Challenge",
  "key": "weekly-words",
  "rankBy": "metric",
  "metricKey": "flashcards-flipped",
  "metricName": "Flashcards Flipped",
  "pointsSystemKey": null,
  "pointsSystemName": null,
  "description": "Compete weekly to see who writes the most words",
  "start": "2025-01-01",
  "end": null,
  "maxParticipants": 100,
  "runUnit": "day",
  "runInterval": 7,
  "rank": 2,
  "value": 4500,
  "history": [
    {
      "timestamp": "2025-01-15T10:30:00Z",
      "previousRank": null,
      "rank": 5,
      "previousValue": null,
      "value": 1000
    },
    {
      "timestamp": "2025-01-15T14:15:00Z",
      "previousRank": 5,
      "rank": 3,
      "previousValue": 1000,
      "value": 3000
    },
    {
      "timestamp": "2025-01-15T18:45:00Z",
      "previousRank": 3,
      "rank": 2,
      "previousValue": 3000,
      "value": 4500
    }
  ]
}

Analytics

The leaderboards page in Trophy shows how many users are actively participating in a leaderboard, as well as a measure of competitiveness based on how many rank changes are occurring. The analytics page also shows a distribution of users scores to help identify clusters of users within rankings.

Additionally the leaderboard rankings page shows current and past rankings of a leaderboard:

Get Support

Want to get in touch with the Trophy team? Reach out to us via email. We’re here to help!

Feature Guides

Use Cases

How To Build A Leaderboards Feature

Pre-requisites

Trophy Setup

Installing Trophy SDK

Tracking User Interactions

Displaying Leaderboards

Pop-up Notifications

Displaying Leaderboard Rankings

Displaying User Rank History

Analytics

Get Support

​Pre-requisites

​Trophy Setup

​Installing Trophy SDK

​Tracking User Interactions

​Displaying Leaderboards

​Pop-up Notifications

​Displaying Leaderboard Rankings

​Displaying User Rank History

​Analytics

​Get Support

Pre-requisites

Trophy Setup

Installing Trophy SDK

Tracking User Interactions

Displaying Leaderboards

Pop-up Notifications

Displaying Leaderboard Rankings

Displaying User Rank History

Analytics

Get Support