HEheroiclabs
Console

List leaderboard records.

get/v2/console/leaderboard/{leaderboard_id}/records

Request

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

Path parameters

leaderboard_idstring required

The ID of the leaderboard to list for.

Query parameters

owner_idsstring[]

One or more owners to retrieve records for.

limitinteger

Max number of records to return. Between 1 and 100.

cursorstring

A next or previous page cursor.

expirystring int64

Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.

Response

A successful response.

next_cursorstring

The cursor to send when retrieving the next page, if any.

prev_cursorstring

The cursor to send when retrieving the previous page, if any.

rank_countstring int64

The total number of ranks available.

Changes

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