API Reference

Add

post
https://us-central1-readysandbox.cloudfunctions.net/leaderboardV2-add

Add a new leaderboard

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Application identifier

string

Unique id of the leaderboard.

appIds
array of strings
required

List of application ids where this leaderboard is used.

appIds*
string
required

Leaderboard request name. This value can be used to query leaderboards.

tags
array of strings

List of tags to filter the leaderboards. Used for categorization.

tags
string
required

Leaderboard name. Is also used to store localization key for the name.

string
required

Leaderboard description. Is also used to store localization key for the description.

string
enum
required

Defines who can set/add scores to the leaderboard:

  • client - the client and the server can set/add scores to the leaderboard.
  • server - only the server can set/add scores to the leaderboard.
Allowed:
boolean
required

Sorting direction. False for descending order, true for ascending order.

integer
required

Determines how many digits of the score are displayed after the decimal point.

string
enum
Defaults to numeric

The leaderboard type that determines the results unit. Default is 'numeric'. Possible values:

  • time - the leaderboard is time-based.
  • numeric - the leaderboard is numeric-based.
Allowed:
rewardsAtReset
array of objects

Rewards which will be earned at reset period.

rewardsAtReset
string
enum

The leaderboard rewards draw type that determines how the leaderboard should draw rewards, possible values:

  • placeBased - rewards will be drawn accordingly users places.
  • scoreBased - rewards will be drawn randomly, but users with higher score will have more chance to win.
  • scoreBasedOnePerUser - same as the scoreBased, but with limitation for one reward at whole leaderboard per one user.
  • scoreBasedOnePerUserAndReward - same as the scoreBased, but with limitation for one unique reward per one user but different rewards could be added to same user.
Allowed:
time
object
required

The time when the leaderboard is available.

requiredToJoin
object

Join leaderboard requirements. To setScore and addScore to the leaderboard.

boolean

Indicates whether the leaderboard rewards are automatically claimed by the user. If false, the rewards must be claimed manually. The time.end is required and optionally time.grace to be set if autoClaim is true.

participationFees
array of objects

List of participation fees for the leaderboard. The fees are deducted when the user sets or adds a score to the leaderboard for the first time.

participationFees
participationRewards
array of strings

List of achievement ids that are triggered for the first score set or added to the leaderboard.

participationRewards
scoreMultipliers
object
fakeEntries
object

Fake entries for the leaderboard.

boolean

Indicates whether the leaderboard entries with zero score should be filtered out. If true, the entries with zero score are not displayed in the leaderboard.

Responses

400

Invalid input parameters

409

Leaderboard already exists

Updated over 1 year ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago