API Reference
Start typing to search…

Retrieve leaderboard competition entries by a list of application IDs

post https://us-central1-readysandbox.cloudfunctions.net/leaderboardCompetitions-getByAppIds
Log in to see full request history
Body Params
appIds
array of strings
required

The list of application IDs to find leaderboards.

appIds*
integer
required

The maximum number of leaderboard competitions to retrieve.

number

A number to start the retrieval after based on 'updatedAt' property.

boolean
Defaults to false

If true, the time.start+promo and time.end+grace will be ignored.

boolean
Defaults to false

Flag to include user data in the response. Default is false.

Responses

Response body
object
leaderboardCompetitions
array of objects
leaderboardCompetitions
object
string

Unique id of the leaderboard.

appIds
array of strings

List of application ids where this leaderboard is used.

appIds
string

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

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

string

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

string

Defines who can reset the leaderboard competition to draw the rewards:

  • client - the client and the server can reset the leaderboard competition.
  • server - only the server can reset the leaderboard competition.

client server

boolean

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

integer

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

rewardsAtReset
array of objects

Rewards which will be earned at reset period.

rewardsAtReset
object
integer
required

The place from which users will earn the reward.

integer
required

The place up to which users will earn the reward.

string
required

Specifies the reward or achievement, which may contain virtual items, currency rewards, etc.

time
object

The time when the leaderboard is available.

leaderboardIds
array of strings

List of leaderboard ids in the competition.

leaderboardIds
int64

Date and time when the leaderboard was created in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

int64

Date and time when the leaderboard was last updated in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

string

User Id who created the leaderboard. This field is automatically populated by the backend.

string

User Id who last time updated the leaderboard. This field is automatically populated by the backend.

leaderboards
array of objects
leaderboards
object
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
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.

client server

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
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.

time numeric

rewardsAtReset
array of objects

Rewards which will be earned at reset period.

rewardsAtReset
object
integer
required

The place from which users will earn the reward.

integer
required

The place up to which users will earn the reward.

string
required

Specifies the reward or achievement, which may contain virtual items, currency rewards, etc.

string

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.

placeBased scoreBased scoreBasedOnePerUser scoreBasedOnePerUserAndReward

int64

Date and time when the leaderboard was created in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

int64

Date and time when the leaderboard was last updated in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

string

User Id who created the leaderboard. This field is automatically populated by the backend.

string

User Id who last time updated the leaderboard. This field is automatically populated by the backend.

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
object
string
required

Specifies the type of the participation fee.
Available types are:

  • currency - the user needs to pay a specific amount of currency to join a leaderboard.
  • gamepass_by_id - the user needs to have a gamepass with a specific id to join a leaderboard.
  • gamepass_by_request_name - the user needs to have a gamepass with a specific request name to join a
    leaderboard.

currency gamepass_by_id gamepass_by_request_name

string
required

The id of the entity to check in user data. For example, if the type is gamepass_by_id, the id is the id of the gamepass. If the type is gamepass_by_request_name, the id is the request name of the gamepass.

integer
≥ 1

The quantity of the entity to check in user data. For example, if the type is currency, the quantity is the amount of currency. If the type is gamepass_by_id, the quantity is the quantity of the game passes the user needs to have.

participationRewards
array of strings

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

participationRewards
scoreMultipliers
object

List of score multipliers for the leaderboard.

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.

participations
array of objects
participations
object
string

The ID of the leaderboard competition

participationLeaderboardIds
array of strings

List of leaderboard ids in which the user is participating.

participationLeaderboardIds
int64

Date and time when the leaderboard competition participation was created in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

int64

Date and time when the leaderboard competition participation was last updated in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

410

No leaderboard found with the provided 'appIds'.

Updated about 2 months ago

Did this page help you?
Language
Credentials
URL

Updated about 2 months ago

Did this page help you?