CLICommands

leaderboard

snug leaderboard <COMMAND>

Leaderboard operations.

Subcommands

CommandWhat it does
createCreate a new leaderboard
getGet leaderboard details by ID
listList leaderboards
updateUpdate a leaderboard
deleteDelete a leaderboard
submitSubmit scores to a leaderboard
batch-submitSubmit scores for many entities from a JSON file (array of submissions, each with an id)
topGet top entries from a leaderboard
time-windowGet top entries within a time window
metric-topGet top entries for a specific metric
rankGet rank for a specific entity
surroundingGet surrounding ranks for an entity
delete-entityDelete an entity from leaderboards
delete-namespaceDelete an entire namespace
delete-metricDelete a metric from a namespace
namespacesList all namespaces
metricsList metrics in a namespace

Run snug leaderboard <command> --help for that command's own options. The global options apply everywhere.

Examples

snug leaderboard create --name "Season 1" --description "Spring competition" --max-entries 10000 --tags game:battle-royale,season:1
snug leaderboard list --limit 10 --active true
snug leaderboard get --id abc123
snug leaderboard update --id abc123 --name "Season 1 Updated" --active false
snug leaderboard delete --id abc123 --force
snug leaderboard submit -n game1 -i player123 -m score:100,kills:10 -d '{"username":"ProGamer"}'
snug leaderboard top -n game1 -l 10 -w score:2.0,kills:1.5
snug leaderboard time-window -n game1 -s 1700000000 -e 1700003600 -l 25
snug leaderboard metric-top -n game1 -m assists -l 15
snug leaderboard rank -n game1 -i player123
snug leaderboard surrounding -n game1 -i player123 -w 5
snug leaderboard delete-entity -n game1 -i player123
snug leaderboard delete-namespace -n game1 --force
snug leaderboard delete-metric -n game1 -m score
snug leaderboard namespaces
snug leaderboard metrics -n game1

Next

On this page