/leaderboard

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

auth_bearersession_secret

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/leaderboard

HTTPcURLJavaScriptPython

GET /api/rest/leaderboard HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

auth_bearersession_secret

AuthorizationstringRequired

Body

application/json

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.

Possible values:

scoreStrategyTypeundefined · enumRequired

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

Possible values:

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

/leaderboard

HTTPcURLJavaScriptPython

POST /api/rest/leaderboard HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "id": null,
  "name": null,
  "timeStrategyType": "ALL_TIME",
  "scoreStrategyType": "OVERWRITE_IF_GREATER",
  "title": null,
  "scoreUnits": null,
  "firstEpochTimestamp": null,
  "epochInterval": null
}

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

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

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

nameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/leaderboard/{nameOrId}

HTTPcURLJavaScriptPython

GET /api/rest/leaderboard/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates an Leaderboard

put

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

nameOrIdanyRequired

Body

application/json

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.

Possible values:

scoreStrategyTypeundefined · enumRequired

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

Possible values:

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

/leaderboard/{nameOrId}

HTTPcURLJavaScriptPython

PUT /api/rest/leaderboard/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "id": null,
  "name": null,
  "timeStrategyType": "ALL_TIME",
  "scoreStrategyType": "OVERWRITE_IF_GREATER",
  "title": null,
  "scoreUnits": null,
  "firstEpochTimestamp": null,
  "epochInterval": null
}

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

Deletes an Leaderboard

delete

Deletes a specific leaderboard known to the server.

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

nameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

delete

/leaderboard/{nameOrId}

HTTPcURLJavaScriptPython

DELETE /api/rest/leaderboard/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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