/leaderboard
Performs a full-text search of all leaderboards known to the server. As with other full-text endpoints this allows for pagination and offset.
020GET /api/rest/leaderboard HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Gets the metadata for a single leaderboard. This may include more specific details not available in the bulk-get or fetch operation.
The name of the leaderboard. This must be unique across all leaderboards.
[^_]\w+The time strategy for the leaderboard. Current options are ALL_TIME and EPOCHAL.
The score strategy for the leaderboard. Current options are OVERWRITE_IF_GREATER and ACCUMULATE.
The user-presentable name or title for for the leaderboard.
The units-of measure for the score type of the leaderboard.
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.
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.
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"
}Gets the metadata for a single leaderboard. This may include more specific details not availble in the bulk-get or fetch operation.
GET /api/rest/leaderboard/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Performs an update to an existing leaderboard known to the server.
The name of the leaderboard. This must be unique across all leaderboards.
[^_]\w+The time strategy for the leaderboard. Current options are ALL_TIME and EPOCHAL.
The score strategy for the leaderboard. Current options are OVERWRITE_IF_GREATER and ACCUMULATE.
The user-presentable name or title for for the leaderboard.
The units-of measure for the score type of the leaderboard.
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.
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.
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 a specific leaderboard known to the server.
DELETE /api/rest/leaderboard/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Last updated