/leaderboard

Last updated 18 days ago

Get an Leaderboard

get

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

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"
}

Deletes an Leaderboard

delete

Deletes a specific leaderboard known to the server.

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"
}

Search Leaderboards

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

searchanyoptional

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

post

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

Authorizations

Body

idanyoptional

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.

firstEpochTimestampanyoptional

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.

epochIntervalanyoptional

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"
}

Updates an Leaderboard

put

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

Authorizations

Path parameters

nameOrIdanyrequired

Body

idanyoptional

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.

firstEpochTimestampanyoptional

epochIntervalanyoptional

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"
}