@trophyso/node/api/types/LeaderboardRanking.d.ts

NodeJS SDK for the Trophy API

/**
 * A user's ranking in a leaderboard.
 */
export interface LeaderboardRanking {
    /** The ID of the user. */
    userId: string;
    /** The name of the user. May be null if no name is set. */
    userName?: string;
    /** The user's rank in the leaderboard. */
    rank: number;
    /** The user's value for this leaderboard (points, metric value, etc.). */
    value: number;
}