OPoptimove
Leaderboards

Player Enrollment and Score on a Leaderboard

Returns the player's enrollment status and current score on a specific leaderboard. For regular leaderboards isEnrolled is always true once the leaderboard is active.

get/leaderboards/{brandId}/{leaderboardId}/player/{playerId}

Request

  • Base URL
    https://opti-ls-api-us.optimove.net/api
  • URL
    https://opti-ls-api-us.optimove.net/api/leaderboards/{brandId}/{leaderboardId}/player/{playerId}
  • Auth
    none declared

Path parameters

brandIdstring uuid required
Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

Brand UUID returned by GET /brands/default/{tenantId}.

leaderboardIdstring required
Example:lb-11111111-1111-1111-1111-111111111111

Leaderboard UUID (from the leaderboards list id).

playerIdstring required
Example:player-123

Your internal player/customer identifier.

Response

Enrollment record with score.

leaderboardIdstring
playerIdstring
totalAmountinteger

Player's current score on this leaderboard.

isEnrolledboolean

Whether the player is participating. For regular leaderboards this is always true once active.

enrolledAtstring date-time nullable

When the player joined. null if not enrolled.

costCurrencyIdstring uuid nullable

UUID of the currency spent to enter (tournaments only). null if free.

costAmountinteger nullable

Amount of currency spent to enter (tournaments only). null if free.

Changes

No recorded changes to this operation across all 1 revision of this API.