[Gametize Tech] API: Leaderboard

Overview

Leaderboard serves an important function in a project to motivate players and provide a clear indication of progress. The leaderboard returns ranks and points earned by players. In Gametize, there are 2 types of Leaderboard: Player and Team. Team leaderboard can be retrieved if Team function is enabled in a project.

Important:
- For Leaderboard, `session_key` is not required for Public Project.
- For Leaderboard Overview, `session_key` is required since the overview is based on a user's perspective.

Time Frame Support:
`type` in the leaderboard API represents time frame. It can be optionally supplied to the API call to specify the time frame of the points collected by players.

Time frames:
- `overall` (default - not required to be specified)
- `daily`
- `monthly`

Player Leaderboard

Project Leaderboard
https://gametize.com/api2/projects/[Project ID]/leaderboard.json
type is optional.

Project Leaderboard Overview
https://gametize.com/api2/projects/[Project ID]/leaderboard_overview.json
type is optional.

Topic Leaderboard
https://gametize.com/api2/topics/[Topic ID]/leaderboard.json
session_key is required.
type is optional.

Topic Leaderboard Overview
https://gametize.com/api2/topics/[Topic ID]/leaderboard_overview.json
session_key is required.
type is optional.

Team Leaderboard

Project Leaderboard
https://gametize.com/api2/projects/[Project ID]/leaderboard.json?team=true
type is optional.

Project Leaderboard Overview
https://gametize.com/api2/projects/[Project ID]/leaderboard_overview.json?team=true
type is optional.

Topic Leaderboard
https://gametize.com/api2/topics/[Topic ID]/leaderboard.json?team=true
session_key is required.
type is optional.

Topic Leaderboard Overview
https://gametize.com/api2/topics/[Topic ID]/leaderboard_overview.json?team=true
session_key is required.
type is optional.

Note:

The article's technical specifications and details are subject to potential changes based on our discretion. It is important to note that the information presented in the article might have become outdated or lost its relevance in the present context.

If you are interested to learn more about this, please drop an email to support@gametize.com with your queries regarding the article!