HEheroiclabs
Console

Get leaderboard.

get/v2/console/leaderboard/{id}

Request

  • Base URL
    http://127.0.0.1:7351
  • Auth
    API key in header Authorization

Path parameters

idstring required

Leaderboard ID

Response

A successful response.

idstring

The ID of the leaderboard.

titlestring

The title for the leaderboard.

descriptionstring

The description of the leaderboard. May be blank.

categoryinteger

The category of the leaderboard. e.g. "vip" could be category 1.

sort_orderinteger

ASC or DESC sort mode of scores in the leaderboard.

sizeinteger

The current number of players in the leaderboard.

max_sizeinteger

The maximum number of players for the leaderboard.

max_num_scoreinteger

The maximum score updates allowed per player for the current leaderboard.

operatorinteger
end_activeinteger

The UNIX time when the leaderboard stops being active until next reset. A computed value.

reset_schedulestring

Reset cron expression.

metadatastring

Additional information stored as a JSON object.

create_timestring date-time

The UNIX time when the leaderboard was created.

start_timestring date-time

The UNIX time when the leaderboard will start.

end_timestring date-time

The UNIX time when the leaderboard will be stopped.

durationinteger

Duration of the tournament in seconds.

start_activeinteger

The UNIX time when the leaderboard start being active. A computed value.

join_requiredboolean

Join required.

authoritativeboolean

Authoritative.

tournamentboolean

Tournament.

prev_resetinteger

The UNIX time when the tournament was last reset. A computed value.

next_resetinteger

The UNIX time when the tournament is next playable. A computed value.

Changes

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