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.

get

/leaderboard

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

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

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

post

/leaderboard

Authorizations

Body

idany

nameanyrequired

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

Pattern: [^_]\w+

titleanyrequired

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

scoreUnitsanyrequired

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.

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

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,
    "title": null,
    "scoreUnits": null,
    "firstEpochTimestamp": null,
    "epochInterval": null,
    "timeStrategyType": "ALL_TIME",
    "scoreStrategyType": "OVERWRITE_IF_GREATER"
  }'

400

401

403

404

409

500

501

503

default

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

get

/leaderboard/{nameOrId}

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

Updates an Leaderboard

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

put

/leaderboard/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Body

idany

nameanyrequired

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

Pattern: [^_]\w+

titleanyrequired

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

scoreUnitsanyrequired

The units-of measure for the score type of the leaderboard.

firstEpochTimestampany

epochIntervalany

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

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,
    "title": null,
    "scoreUnits": null,
    "firstEpochTimestamp": null,
    "epochInterval": null,
    "timeStrategyType": "ALL_TIME",
    "scoreStrategyType": "OVERWRITE_IF_GREATER"
  }'

400

401

403

404

409

500

501

503

default

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

Deletes an Leaderboard

Deletes a specific leaderboard known to the server.

delete

/leaderboard/{nameOrId}

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

Gets Rank Among all Players

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

get

/rank/global/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If not provided, the current epoch will be used by default for epochal leaderboards. This value will be ignored for all-time leaderboards. Set this value to 0 to explicitly reference the current epoch (when applicable).

Responses

application/json

text/csv

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/global/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets Rank among Friends

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

get

/rank/friends/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

offsetany · default: 0

May be negative to place the requested player in the middle of the page.

countany · default: 20

The number of results to return in the page.

relativeany · default: false

Indicates whether or not to fetch results in a relative fashion.

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/friends/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets Rank among Mutual Followers

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

get

/rank/mutual_followers/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

offsetany · default: 0

May be negative to place the requested player in the middle of the page.

countany · default: 20

The number of results to return in the page.

relativeany · default: false

Indicates whether or not to fetch results in a relative fashion.

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/mutual_followers/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

post

/score/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

The name or id of the leaderboard.

Body

idanyrequired

The ID of the Score

profileobjectrequired

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.

creationTimestampanyrequired

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

leaderboardEpochanyrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/score/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "active": null,
        "facebookId": null,
        "firebaseId": null,
        "appleSignInId": null,
        "googleSignInId": null,
        "externalUserId": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "description": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "name": null,
        "applicationConfiguration": "[Circular Reference]",
        "attributes": null
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "lastModified": null,
        "state": "EMPTY"
      },
      "displayName": null,
      "lastLogin": null,
      "metadata": null
    },
    "pointValue": null,
    "scoreUnits": null,
    "creationTimestamp": null,
    "leaderboardEpoch": null
  }'

400

401

403

404

409

500

501

503

default

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