Leaderboards Metadata API
Capture users' scores
The Leaderboards Metadata API
Some games may have multiple types of scores. You can use The Leaderboard Metadata API to understand what each of those score values represents in the context of the game.
GET
Leaderboards Metadata API
Leaderboard usage is only available with paid plans. Contact us to know more.
Understanding Leaderboards
Let’s say there’s an endless runner game with 2 modes: “easy” and “hard”. If you wanted to create leaderboards for the game for your users, it would only be fair that there are 2 separate leaderboards — one for the easy mode, and one for the hard mode. To be able to do that, you need to distinguish which mode the user was playing in when we post a score to your webhook. This is where Leaderboards come in. Scores are not recorded against a game, they are recorded against a Leaderboard. A game may have more than one Leaderboard. Note: This API does not return user scores sorted as in a leaderboard. Instead, it returns metadata on the different Leaderboards that exist for any game.Most games have a single Leaderboard. This document is useful if you’re taking a game from us which has multiple Leaderboards.
Get all Leaderboards for a game
The Leaderboards Metadata API can be used to fetch details of all the Leaderboards that can be made for a particular game.Authorizations
You can find the Bearer token for this API under Settings & Admin > API Tokens within the Gamezop Business Dashboard.
Query Parameters
The unique code of the Gamezop game for which you want to fetch Leaderboards' metadata. You can find the code for any game from the All Games API