Leaderboards | Elements Manual

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.

GEThttp://localhost:8080/api/rest/leaderboard

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/leaderboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

POSThttp://localhost:8080/api/rest/leaderboard

Body

idany

name*any

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

Pattern: [^_]\w+

timeStrategyType*enum

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

ALL_TIMEEPOCHAL

scoreStrategyType*enum

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

OVERWRITE_IF_GREATERACCUMULATE

title*any

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

scoreUnits*any

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.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/leaderboard', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scoreStrategyType": "OVERWRITE_IF_GREATER",
      "timeStrategyType": "ALL_TIME"
    }),
});
const data = await response.json();

Response

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

GEThttp://localhost:8080/api/rest/leaderboard/{nameOrId}

Path parameters

nameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/leaderboard/{nameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Updates an Leaderboard

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

PUThttp://localhost:8080/api/rest/leaderboard/{nameOrId}

Path parameters

nameOrId*any

Body

idany

name*any

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

Pattern: [^_]\w+

timeStrategyType*enum

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

ALL_TIMEEPOCHAL

scoreStrategyType*enum

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

OVERWRITE_IF_GREATERACCUMULATE

title*any

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

scoreUnits*any

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.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/leaderboard/{nameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scoreStrategyType": "OVERWRITE_IF_GREATER",
      "timeStrategyType": "ALL_TIME"
    }),
});
const data = await response.json();

Response

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

Deletes an Leaderboard

Deletes a specific leaderboard known to the server.

DELETEhttp://localhost:8080/api/rest/leaderboard/{nameOrId}

Path parameters

nameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/leaderboard/{nameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Gets Rank Among all Players

Gets the current Profile's rank among all players for the particular leaderboard.

GEThttp://localhost:8080/api/rest/rank/global/{leaderboardNameOrId}

Path parameters

leaderboardNameOrId*any

Specifies the leaderboard name or ID.

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/rank/global/{leaderboardNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Gets Rank among Friends

Gets the current Profile's rank among friends for the particular leaderboard.

GEThttp://localhost:8080/api/rest/rank/friends/{leaderboardNameOrId}

Path parameters

leaderboardNameOrId*any

Specifies the leaderboard name or ID.

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/rank/friends/{leaderboardNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Gets Rank among Mutual Followers

Gets the current Profile's rank among mutual followers for the particular leaderboard.

GEThttp://localhost:8080/api/rest/rank/mutual_followers/{leaderboardNameOrId}

Path parameters

leaderboardNameOrId*any

Specifies the leaderboard name or ID.

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/rank/mutual_followers/{leaderboardNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Creates a New Score

Posts a single score for the currently logged-in profile. Conceptually, this is creationg a new resource, however the server may opt to overwrite the existing identifier if it sees fit.

POSThttp://localhost:8080/api/rest/score/{leaderboardNameOrId}

Path parameters

leaderboardNameOrId*any

The name or id of the leaderboard.

Body

id*any

The ID of the Score

profile*Profile (object)

pointValueany

The point value of the score.

scoreUnitsany

The the units of measure for the points. For example, if the points in the game were called "coins" instead of "points" this would be used to designate as such in the UI.

creationTimestamp*any

The time at which the score was created on the server.

leaderboardEpoch*any

The epoch to which the score belongs for the associated leaderboard. By convention, if the leaderboard is all-time, this value will be set to zero.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/score/{leaderboardNameOrId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "profile": {
        "application": {},
        "user": {
          "level": "UNPRIVILEGED"
        }
      }
    }),
});
const data = await response.json();

Response

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