Retrieve leaderboard resets

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

Responses

Response body

object

resets

array of objects

resets

object

string

Unique id of the leaderboard reset.

resetAt

int64

Date and time when the leaderboard will be reset in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

rewardsGivenAt

int64

Date and time when the leaderboard rewards were given in milliseconds since Jan 1, 1970 UTC. Automatically populated by the backend.

totalGivenRewardsCount

integer

The total count of given rewards.

entries

array of objects

List of leaderboard entries.

entries

object

userId

string

required

Unique identifier of the user.

displayName

string

required

Displayed name of the user.

profilePicture

object

required

URL of the user's profile picture.

score

integer

required

Score of the user.

formattedScore

string

required

Score of the user formatted as a string.

place

integer

required

Rank or place of the user on the leaderboard.

extraData

string

required

Extra data associated with the user's score entry.

createdAt

int64

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

updatedAt

int64

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

failedRewards

array of objects

List of rewards that the user failed to earn. This field is only present if the user failed to earn rewards.

failedRewards

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.

givenRewards

array of objects

List of rewards that the user earned. This field is only present if the user earned rewards.

givenRewards

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.

400

Invalid argument

403

Permission denied

410

Leaderboard not found

Language

Credentials

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/leaderboardV2-getResets \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "withEntries": true,
8
  "orderDirection": "asc"
9
}
10
'


xxxxxxxxxx
42
}
1
{
2
  "resets": [
3
    {
4
      "id": "string",
5
      "resetAt": 0,
6
      "rewardsGivenAt": 0,
7
      "totalGivenRewardsCount": 0,
8
      "entries": [
9
        {
10
          "userId": "string",
11
          "displayName": "string",
12
          "profilePicture": {
13
            "source": "string",
14
            "large": "string",
15
            "medium": "string",
16
            "small": "string"
17
          },
18
          "score": 0,
19
          "formattedScore": "string",
20
          "place": 0,
21
          "extraData": "string",
22
          "createdAt": 0,
23
          "updatedAt": 0,
24
          "failedRewards": [
25
            {

200Successful response

401Unauthenticated error 401 indicating the user is not authenticated.