/leaderboard

Last updated 1 month 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

objectoptional

application/json

get

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

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

Deletes an Leaderboard

delete

Deletes a specific leaderboard known to the server.

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

objectoptional

application/json

*/*

delete

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

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

offsetanyoptionalDefault: 0

countanyoptionalDefault: 20

searchanyoptional

Responses

application/json

objectoptional

application/json

get

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

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.

Available options:

scoreStrategyTypeundefined · enumrequired

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

Available options:

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

objectoptional

application/json

post

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

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.

Available options:

scoreStrategyTypeundefined · enumrequired

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

Available options:

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

objectoptional

application/json

put

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