Leaderboard

Web API References for Leaderboard Service

Explore the list of Web APIs functions available for managing leaderboards and player scores, including detailed descriptions and usage examples.

To use services functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From game's dashboard header.

Retrieves a list of leaderboards based on the provided parameters.

get

Query parameters

labelstringOptional

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Responses

200

OK

totalCountinteger · int32Optional

get/api/table/services/leaderboard

GET /api/table/services/leaderboard HTTP/1.1
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "label": "text",
      "unique_by": "text",
      "order": 0,
      "actions": "text",
      "extend_table": "text",
      "participants": 0,
      "course": 1,
      "timeframe": 1,
      "ttl": 1,
      "round": 1,
      "winners_count": 1,
      "last_wipe": "2026-01-01T00:00:00.000Z"
    }
  ],
  "totalCount": 1
}

Obtains scores for individual users as specified by the input parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

return_mebooleanOptional

Responses

200

OK

totalCountinteger · int32Optional

post/api/table/services/leaderboard/user/{leaderboardId}

POST /api/table/services/leaderboard/user/{leaderboardId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

200

OK

{
  "list": [],
  "totalCount": 1
}

Fetches scores for different parties according to the given parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

return_mebooleanOptional

Responses

200

OK

totalCountinteger · int32Optional

post/api/table/services/leaderboard/party/{leaderboardId}

POST /api/table/services/leaderboard/party/{leaderboardId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

200

OK

{
  "list": [],
  "totalCount": 1
}

Retrieves the score of the current user based on the input parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Body

return_mebooleanOptional

Responses

200

OK

rowany · nullableOptional

post/api/table/services/leaderboard/{leaderboardId}/me

POST /api/table/services/leaderboard/{leaderboardId}/me HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

200

OK

{
  "row": null
}

Gathers scores specifically for friends of the current user.

get

Path parameters

leaderboardIdinteger · int32Required

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

opstring · nullableOptional

fieldstring · nullableOptional

valueany · nullableOptional

Responses

200

OK

rowany · nullableOptional

get/api/table/services/leaderboard/{leaderboardId}/friends

GET /api/table/services/leaderboard/{leaderboardId}/friends HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "op": "text",
  "field": "text",
  "value": null,
  "values": [],
  "list": [
    {
      "op": "text",
      "field": "text",
      "value": null,
      "values": [],
      "list": [
        {
          "op": "text",
          "field": "text",
          "value": null,
          "values": [],
          "list": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

200

OK

{
  "row": null
}

Submits a user's score and returns the result.

post

Path parameters

leaderboardIdinteger · int32Required

Body

scoreinteger · int32Optional

party_Idinteger · int32Optional

Responses

200

OK

affectedinteger · int32Optional

post/api/table/services/leaderboard/{leaderboardId}

POST /api/table/services/leaderboard/{leaderboardId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "score": 1,
  "other_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "party_Id": 1
}

200

OK

{
  "affected": 1
}