Retrieve a leaderboard competition by ID

post https://us-central1-readysandbox.cloudfunctions.net/leaderboardCompetitions-getById

Responses

Response body

object

leaderboardCompetition

object

Leaderboards competition data

string

Unique id of the leaderboard.

appIds

array of strings

List of application ids where this leaderboard is used.

appIds

requestName

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

name

string

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

description

string

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

setBy

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

invertSortOrder

boolean

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

decimalOffset

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

placeFrom

integer

required

The place from which users will earn the reward.

placeTo

integer

required

The place up to which users will earn the reward.

achievementId

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

createdAt

int64

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

updatedAt

int64

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

createdBy

string

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

updatedBy

string

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

leaderboards

array of objects

The leaderboards associated with the competition.

leaderboards

object

string

Unique id of the leaderboard.

appIds

array of strings

required

List of application ids where this leaderboard is used.

appIds*

requestName

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

name

string

required

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

description

string

required

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

setBy

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

invertSortOrder

boolean

required

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

decimalOffset

integer

required

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

type

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

placeFrom

integer

required

The place from which users will earn the reward.

placeTo

integer

required

The place up to which users will earn the reward.

achievementId

string

required

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

rewardsDrawType

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

createdAt

int64

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

updatedAt

int64

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

createdBy

string

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

updatedBy

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.

autoClaim

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

type

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.

quantity

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.

filterEntriesWithZeroScore

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

The user participation information when the 'withUserData' flag is set to true.

participations

object

string

The ID of the leaderboard competition

participationLeaderboardIds

array of strings

List of leaderboard ids in which the user is participating.

participationLeaderboardIds

createdAt

int64

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

updatedAt

int64

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

403

Permission denied to access the leaderboard with the provided 'id'.

410

Leaderboard not found with the provided 'id'.

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/leaderboardCompetitions-getById \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "withUserData": false
8
}
9
'


xxxxxxxxxx
158
}
1
{
2
  "leaderboardCompetition": {
3
    "id": "string",
4
    "appIds": [
5
      "string"
6
    ],
7
    "requestName": "string",
8
    "tags": [
9
      "string"
10
    ],
11
    "name": "string",
12
    "description": "string",
13
    "setBy": "client",
14
    "invertSortOrder": true,
15
    "decimalOffset": 0,
16
    "rewardsAtReset": [
17
      {
18
        "placeFrom": 0,
19
        "placeTo": 0,
20
        "achievementId": "string"
21
      }
22
    ],
23
    "time": {
24
      "hasStart": true,
25
      "start": 0,

200Leaderboard competition successfully retrieved.

400Invalid arguments. 'id' is missing or not a string.