Leaderboards

Get Leaderboard

Changed on

Returns a single leaderboard.

get/v1/leaderboards/{leaderboard_id}

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/leaderboards/{leaderboard_id}
  • Auth
    HTTP bearer

Path parameters

leaderboard_idstring required

Response

Successful Response

namestring required

The name of the leaderboard.

descriptionstring required

The description of the leaderboard.

visibility'general' | 'personal'
start_atinteger

The start date of the leaderboard in Unix timestamp.If set, the leaderboard will only be visible in game-hub after this date.

end_atinteger

The end date of the leaderboard in Unix timestamp.If set, the leaderboard will only be visible in game-hub before this date.

idstring required

The unique identifier of the leaderboard.

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the path request parameter leaderboard_id, the maxLength was set to 32