기술 자료

​
​

Development

User Acquisition

Monetization

산업 분야

Leaderboards Admin API

v1

지원 가능
​

Leaderboards Admin API

v1

지원 가능
​
이 페이지는 선택한 언어로 제공되지 않습니다.
Unity Services Web APIs
​
​
Leaderboards Admin API
  • Introduction
  • General Information
mdx:openapi:endpoints
  • Leaderboards

Leaderboards Admin API

Introduction

This is the API specification for the Unity Leaderboards Admin service that enables game developers to create and edit leaderboard configurations for their games.

General Information

A leaderboard configuration can be created and edited through this API. In addition, player scores can be retrieved (either as a set of leaderboard entries or for a particular player) and deleted, and leaderboards may be reset, optionally retaining a read-only version of the scores stored in the leaderboard at the time of the reset.

Rate Limits

The API has rate limiting in place. Request are limited to 10 requests per second, and 1000 requests per 30 minute period.
The API responds with a 
429
HTTP status code if the rate limit is exceeded.
It will also respond with a 
Retry-After
header to be used in conjunction with a client's retry logic. The value is the number of seconds until a request for the given player will be accepted.
Download OpenAPI specification:

Create Leaderboard

Add leaderboard to project environment
Authorizations
ServiceAccount (live_ops.leaderboards.configurations.create)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.configurations.create

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

Request body for "{title}"

Media Type:
application/json

id

string
필수
example: my-leaderboard
No description

name

string
필수
example: My Leaderboard
No description

sortOrder

string
필수
The Sort Order of the leaderboard, either Ascending (asc) or Descending (desc)

updateType

string
필수
The Update Type of the leaderboard, currently limited to Keep Best Score (keepBest), Keep Latest Score (keepLatest) or Keep Total Score (aggregate). This determines how to handle new scores that players submit.

bucketSize

integer
Configure bucketing on the leaderboard by specifying the maximum bucket size. A bucketed leaderboard segments players into buckets of the specified size, assigning players to buckets on a first come, first serve basis. Buckets aren't visible to players. Note that you can't change this configuration after you've created the leaderboard.

resetConfig

object
Configuration for automatic scheduled resets to apply to the leaderboard.

start

string
필수
example: 2025-07-08T15:04:05Z
The date and time that the first reset should occur, formatted according to the RFC-3339 specification. If 
start
is provided without a schedule, then a one-off reset will occur at the date and time specified by 
start
. The date and time specified by 
start
must be later that the time of the request. Accuracy of the 
start
date and time is maintained to the minute.

schedule

string
example: @every 1h
The schedule on which to reset the leaderboard. Can be either a valid five-element cron tab or a cron string using 
@every
shorthand (see Cron Package Specifications for details), e.g. "@every 72h" for a leaderboard reset every three days. The schedule will be applied after the first reset specified by 
start
. The schedule can not be more frequent than once per minute.

archive

boolean
Whether or not to archive the current set of scores before resetting the leaderboard

tieringConfig

object
Configuration for tiers to apply to the leaderboard.

strategy

string
필수
The tiering strategy to use when determining what tier a player is in.

tiers

array[object]
필수
example: [{"id":"gold","cutoff":100},{"id":"silver","cutoff":50},{"id":"bronze"}]
No description

id

string
필수
example: gold
The ID of the tier.

cutoff

number
example: 100
Exactly one tier in the 
tiers
array must omit this value to act as the default tier.
The worst value to include in the tier. For score-based tiers, this relates to your sort order. For a descending leaderboard, the tier includes entries with this score and higher. For an ascending leaderboard, the tier includes entries with this score and lower. For rank and percentage-based tiers, the tier includes entries with this rank or percentage and better. Percentage-based cutoffs are like rank-based cutoffs that scale with your number of players. For example, if you specify a percentage-based cutoff of 
10
, a leaderboard of 100 players would include ranks 0-9 in the tier, whereas with 1000 players the tier would include ranks 0-99. Specify percentage-based cutoffs as the percentage desired without the percent symbol, e.g. 
10
for 10%.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "id": "my-leaderboard", "name": "My Leaderboard", "sortOrder": "desc", "updateType": "keepBest", "bucketSize": 0, "resetConfig": { "start": "2025-07-08T15:04:05Z", "schedule": "@every 1h", "archive": true }, "tieringConfig": { "strategy": "score", "tiers": [ { "id": "gold", "cutoff": 100 }, { "id": "silver", "cutoff": 50 }, { "id": "bronze" } ] }}' \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards"

Response example

{ "type": "string", "title": "Bad Request", "status": 400, "code": 1002, "detail": "Failed to parse request body. Error: Unexpected end of JSON input", "instance": "string"}

Get Leaderboard Configs

List leaderboard configurations for the given project environment
Authorizations
ServiceAccount (live_ops.leaderboards.configurations.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.configurations.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

Query parameters for "{title}"

cursor

string
The ID of the leaderboard that listing should start after, i.e. the last leaderboard returned from the previous page when paging

limit

integer
The number of leaderboards to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards"

Response example

{ "results": [ { "updated": "2024-01-01T00:00:00Z", "created": "2024-01-01T00:00:00Z", "lastReset": "2024-01-01T00:00:00Z", "versions": [ { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" } ] } ], "pageInfo": { "endCursor": "my-leaderboard" }}

Get Leaderboard Config

Retrieves the configuration for a specific leaderboard
Authorizations
ServiceAccount (live_ops.leaderboards.configurations.get)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.configurations.get

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}"

Response example

{ "updated": "2024-01-01T00:00:00Z", "created": "2024-01-01T00:00:00Z", "lastReset": "2024-01-01T00:00:00Z", "versions": [ { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" } ]}

Update Leaderboard Config

Updates the configuration for a specific leaderboard
Authorizations
ServiceAccount (live_ops.leaderboards.configurations.update)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.configurations.update

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

Request body for "{title}"

Media Type:
application/json

name

string
example: My Leaderboard
No description

sortOrder

string
The Sort Order of the leaderboard, either Ascending (asc) or Descending (desc)

updateType

string
The Update Type of the leaderboard, currently limited to Keep Best Score (keepBest), Keep Latest Score (keepLatest) or Keep Total Score (aggregate). This determines how to handle new scores that players submit.

resetConfig

object
Configuration for automatic scheduled resets to apply to the leaderboard.

start

string
필수
example: 2025-07-08T15:04:05Z
The date and time that the first reset should occur, formatted according to the RFC-3339 specification. If 
start
is provided without a schedule, then a one-off reset will occur at the date and time specified by 
start
. The date and time specified by 
start
must be later that the time of the request. Accuracy of the 
start
date and time is maintained to the minute.

schedule

string
example: @every 1h
The schedule on which to reset the leaderboard. Can be either a valid five-element cron tab or a cron string using 
@every
shorthand (see Cron Package Specifications for details), e.g. "@every 72h" for a leaderboard reset every three days. The schedule will be applied after the first reset specified by 
start
. The schedule can not be more frequent than once per minute.

archive

boolean
Whether or not to archive the current set of scores before resetting the leaderboard

tieringConfig

object
Configuration for tiers to apply to the leaderboard.

strategy

string
필수
The tiering strategy to use when determining what tier a player is in.

tiers

array[object]
필수
example: [{"id":"gold","cutoff":100},{"id":"silver","cutoff":50},{"id":"bronze"}]
No description

id

string
필수
example: gold
The ID of the tier.

cutoff

number
example: 100
Exactly one tier in the 
tiers
array must omit this value to act as the default tier.
The worst value to include in the tier. For score-based tiers, this relates to your sort order. For a descending leaderboard, the tier includes entries with this score and higher. For an ascending leaderboard, the tier includes entries with this score and lower. For rank and percentage-based tiers, the tier includes entries with this rank or percentage and better. Percentage-based cutoffs are like rank-based cutoffs that scale with your number of players. For example, if you specify a percentage-based cutoff of 
10
, a leaderboard of 100 players would include ranks 0-9 in the tier, whereas with 1000 players the tier would include ranks 0-99. Specify percentage-based cutoffs as the percentage desired without the percent symbol, e.g. 
10
for 10%.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "My Leaderboard", "sortOrder": "desc", "updateType": "keepBest", "resetConfig": { "start": "2025-07-08T15:04:05Z", "schedule": "@every 1h", "archive": true }, "tieringConfig": { "strategy": "score", "tiers": [ { "id": "gold", "cutoff": 100 }, { "id": "silver", "cutoff": 50 }, { "id": "bronze" } ] }}' \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}"

Response example

{ "type": "string", "title": "Bad Request", "status": 400, "code": 1002, "detail": "Failed to parse request body. Error: Unexpected end of JSON input", "instance": "string"}

Delete Leaderboard

Deletes the configuration and scores for a specific leaderboard
Authorizations
ServiceAccount (live_ops.leaderboards.configurations.delete)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.configurations.delete

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}"

Response example

{ "type": "problems/basic", "title": "Unauthorized", "status": 401, "code": 1005, "detail": "Unauthorized"}

Get Bucket IDs

Retrieves the bucket IDs for a specific bucketed leaderboard
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

Query parameters for "{title}"

offset

integer
The number of buckets to skip when retrieving the leaderboard bucket IDs. Defaults to 0

limit

integer
The maximum number of leaderboard bucket IDs to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/buckets"

Response example

{ "offset": 0, "limit": 10, "total": 1, "results": [ "8bdacc33-6eef-4577-beb0-633c86259f5b" ]}

Get Scores

Get list of scores and ranks for the specified leaderboard, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard scores. Defaults to 0

limit

integer
The number of leaderboard scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores"

Response example

{ "offset": 0, "limit": 10, "total": 1, "results": [ { "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold" } ]}

Reset Scores

Reset the scores for the specified leaderboard, optionally archiving the existing scores before resetting. When archiving, the operation will return the version ID of the archive version that has been created. Each leaderboard can have up to 10,000 archives. Beyond this limit, the system will automatically delete the oldest archives on a first-in, first-out (FIFO) basis.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.delete)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.delete

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

Query parameters for "{title}"

archive

boolean
Whether or not to archive the current set of scores before resetting the leaderboard

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores"

Response example

{ "versionId": "20230213175322850781977"}

Get Scores By Tier

Get list of scores and ranks for the specified leaderboard, within the specified tier, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

tierId

string
필수
example: gold
ID of the leaderboard tier.

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard scores. Defaults to 0

limit

integer
The number of leaderboard scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/tiers/{tierId}/scores"

Response example

{ "tier": "gold"}

Get Bucket Scores

Get list of scores and ranks for the specified bucket from the specified leaderboard, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

bucketId

필수
example: aa74a353-8919-47e4-8645-6e5517055472
ID of the leaderboard bucket

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard bucket scores. Defaults to 0

limit

integer
The number of leaderboard bucket scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/buckets/{bucketId}/scores"

Response example

{ "offset": 0, "limit": 10, "total": 1, "results": [ { "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold" } ]}

Get Bucket Scores By Tier

Get list of scores and ranks for the specified bucket from the specified leaderboard, within the specified tier, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

bucketId

필수
example: aa74a353-8919-47e4-8645-6e5517055472
ID of the leaderboard bucket

tierId

string
필수
example: gold
ID of the leaderboard tier.

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard bucket scores. Defaults to 0

limit

integer
The number of leaderboard bucket scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/buckets/{bucketId}/tiers/{tierId}/scores"

Response example

{ "tier": "gold"}

Get Scores By PlayerIds

Get list of scores and ranks for the specified leaderboard, with specified playerIds.

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

Request body for "{title}"

Media Type:
application/json

playerIds

array[string]
example: ["5drhidte8XgD4658j2eHtSljIAzA","GZWIdLM4I1vFvv1VGhqqDKNPK06b"]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "playerIds": [ "5drhidte8XgD4658j2eHtSljIAzA", "GZWIdLM4I1vFvv1VGhqqDKNPK06b" ]}' \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players"

Response example

{ "results": [ { "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold" } ], "entriesNotFoundForPlayerIds": [ "GZWIdLM4I1vFvv1VGhqqDKNPK06b" ]}

Get Scores By PlayerIds for Archived Leaderboard

Get list of scores and ranks for an archived leaderboard, with specified playerIds.

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

Request body for "{title}"

Media Type:
application/json

playerIds

array[string]
example: ["5drhidte8XgD4658j2eHtSljIAzA","GZWIdLM4I1vFvv1VGhqqDKNPK06b"]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "playerIds": [ "5drhidte8XgD4658j2eHtSljIAzA", "GZWIdLM4I1vFvv1VGhqqDKNPK06b" ]}' \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/scores/players"

Response example

{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }}

Get Player Range

Get the list of neighbouring players for the specified player Id.

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

Query parameters for "{title}"

rangeLimit

integer
The number of entries either side of the player to retrieve. Defaults to 5.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}/range"

Response example

{ "results": [ { "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold" } ]}

Get Player Range for Archived Leaderboard

Get the list of neighbouring players for the specified player Id for an archived leaderboard.

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

Query parameters for "{title}"

rangeLimit

integer
The number of entries either side of the player to retrieve. Defaults to 5.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/scores/players/{playerId}/range"

Response example

{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }, "results": [ { "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold" } ]}

Get Player Score

Get score and rank for the specified player in the specified leaderboard.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.get)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.get

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}"

Response example

{ "updatedTime": "2024-01-01T00:00:00Z", "bucketId": "aa74a353-8919-47e4-8645-6e5517055472", "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold"}

Delete Player Score

Deletes the score for a specific player from a specific leaderboard
Authorizations
ServiceAccount (live_ops.leaderboards.scores.delete)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.delete

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}"

Response example

{ "type": "problems/basic", "title": "Unauthorized", "status": 401, "code": 1005, "detail": "Unauthorized"}

Delete Player Score From All Live Leaderboards

Deletes the score for a specific player from all live leaderboards
Authorizations
ServiceAccount (live_ops.leaderboards.scores.delete)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.delete

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/scores/players/{playerId}/purge"

Response example

{ "type": "string", "title": "Bad Request", "status": 400, "code": 1002, "detail": "Failed to parse request body. Error: Unexpected end of JSON input", "instance": "string"}

Get Version Scores

Get list of scores and ranks for the specified archived leaderboard version, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard version scores. Defaults to 0

limit

integer
The number of leaderboard version scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/scores"

Response example

{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }}

Get Version Scores By Tier

Get list of scores and ranks for the specified archived leaderboard version, within the specified tier, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

tierId

string
필수
example: gold
ID of the leaderboard tier.

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard version scores. Defaults to 0

limit

integer
The number of leaderboard version scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/tiers/{tierId}/scores"

Response example

{ "tier": "gold"}

Get Version Bucket IDs

Get the bucket IDs for a specific bucketed leaderboard archive version, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard version bucket IDs. Defaults to 0

limit

integer
The number of leaderboard version bucket IDs to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/buckets"

Response example

{ "offset": 0, "limit": 10, "total": 1, "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }, "results": [ "8bdacc33-6eef-4577-beb0-633c86259f5b" ]}

Get Version Bucket Scores

Get list of scores and ranks for the specified bucket from the specified leaderboard version, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

bucketId

필수
example: aa74a353-8919-47e4-8645-6e5517055472
ID of the leaderboard bucket

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard version bucket scores. Defaults to 0

limit

integer
The number of leaderboard version bucket scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/buckets/{bucketId}/scores"

Response example

{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }}

Get Version Bucket Scores By Tier

Get list of scores and ranks for the specified bucket from the specified leaderboard version, within the specified tier, with specified pagination.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.list)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.list

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

bucketId

필수
example: aa74a353-8919-47e4-8645-6e5517055472
ID of the leaderboard bucket

tierId

string
필수
example: gold
ID of the leaderboard tier.

Query parameters for "{title}"

offset

integer
The number of entries to skip when retrieving the leaderboard version bucket scores. Defaults to 0

limit

integer
The number of leaderboard version bucket scores to return. Defaults to 10

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/buckets/{bucketId}/tiers/{tierId}/scores"

Response example

{ "tier": "gold"}

Get Version Player Score

Get score and rank for the specified player in the specified archived leaderboard version.
Authorizations
ServiceAccount (live_ops.leaderboards.scores.get)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: live_ops.leaderboards.scores.get

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

playerId

string
필수
example: s1QFdyYFXCC2YBocplKoLstxvQ2r
ID of the player

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}/scores/players/{playerId}"

Response example

{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }, "playerId": "5drhidte8XgD4658j2eHtSljIAzA", "playerName": "Jane Doe", "score": 120.3, "rank": 42, "tier": "gold"}

Delete Leaderboard Version

Delete the specified leaderboard version.

Path parameters for "{title}"

projectId

string
필수
The project's Project ID

environmentId

string
필수
The Environment ID of a project

leaderboardId

string
필수
example: my-leaderboard
ID of the leaderboard, as set by the user. IDs can be listed by retrieving the leaderboard configurations.

versionId

string
필수
example: 20220517135053019266622
ID of the leaderboard version

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://services.api.unity.com/leaderboards/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/versions/{versionId}"

Response example

{ "type": "string", "title": "Bad Request", "status": 400, "code": 1002, "detail": "Failed to parse request body. Error: Unexpected end of JSON input", "instance": "string"}
Copyright © 2026 Unity Technologies
법률 정보개인정보 처리방침쿠키Documentation Terms of Use개인 정보 판매 또는 공유 금지개인정보 보호 선택(쿠키 설정)

'Unity', Unity 로고 및 기타 Unity 상표는 미국 및 기타 지역 내 Unity Technologies 또는 그 계열사의 상표 또는 등록상표입니다(자세한 내용은 여기에서 확인하세요). 기타 명칭 또는 브랜드는 해당 소유자의 상표입니다.

일부 페이지는 편의를 위해 기계 번역되었으며 부정확한 내용이 있을 수 있습니다. 정보가 상충되는 경우, 영어 버전을 우선으로 참조하세요.