/leaderboard

Last updated 10 days ago

Search Leaderboards

Performs a full-text search of all leaderboards known to the server. As with other full-text endpoints this allows for pagination and offset.

get

/leaderboard

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/leaderboard' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a New Leaderboard

Gets the metadata for a single leaderboard. This may include more specific details not available in the bulk-get or fetch operation.

post

/leaderboard

Authorizations

Body

idany

nameanyrequired

The name of the leaderboard. This must be unique across all leaderboards.

Pattern: [^_]\w+

timeStrategyTypeundefined · enumrequired

The time strategy for the leaderboard. Current options are ALL_TIME and EPOCHAL.

Options: ALL_TIME, EPOCHAL

scoreStrategyTypeundefined · enumrequired

The score strategy for the leaderboard. Current options are OVERWRITE_IF_GREATER and ACCUMULATE.

Options: OVERWRITE_IF_GREATER, ACCUMULATE

titleanyrequired

The user-presentable name or title for for the leaderboard.

scoreUnitsanyrequired

The units-of measure for the score type of the leaderboard.

firstEpochTimestampany

The time at which the leaderboard epoch intervals should begin (in ms). If null, then the leaderboard is all-time and not epochal. During creation, if this value is provided, then epochInterval must also be provided.

epochIntervalany

The duration for a leaderboard epoch interval (in ms). If null, then the leaderboard is all-time and not epochal. During creation, if this value is provided, then firstEpochTimestamp must also be provided.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/leaderboard' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": null,
    "name": null,
    "timeStrategyType": "ALL_TIME",
    "scoreStrategyType": "OVERWRITE_IF_GREATER",
    "title": null,
    "scoreUnits": null,
    "firstEpochTimestamp": null,
    "epochInterval": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get an Leaderboard

Gets the metadata for a single leaderboard. This may include more specific details not availble in the bulk-get or fetch operation.

get

/leaderboard/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/leaderboard/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates an Leaderboard

Performs an update to an existing leaderboard known to the server.

put

/leaderboard/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Body

idany

nameanyrequired

The name of the leaderboard. This must be unique across all leaderboards.

Pattern: [^_]\w+

timeStrategyTypeundefined · enumrequired

The time strategy for the leaderboard. Current options are ALL_TIME and EPOCHAL.

Options: ALL_TIME, EPOCHAL

scoreStrategyTypeundefined · enumrequired

The score strategy for the leaderboard. Current options are OVERWRITE_IF_GREATER and ACCUMULATE.

Options: OVERWRITE_IF_GREATER, ACCUMULATE

titleanyrequired

The user-presentable name or title for for the leaderboard.

scoreUnitsanyrequired

The units-of measure for the score type of the leaderboard.

firstEpochTimestampany

epochIntervalany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/leaderboard/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": null,
    "name": null,
    "timeStrategyType": "ALL_TIME",
    "scoreStrategyType": "OVERWRITE_IF_GREATER",
    "title": null,
    "scoreUnits": null,
    "firstEpochTimestamp": null,
    "epochInterval": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes an Leaderboard

Deletes a specific leaderboard known to the server.

delete

/leaderboard/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/leaderboard/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}