API Reference

Leaderboard

get
https://gamify-api-{region}.optimove.net/adact/campaigns//leaderboard

This endpoint allows you to query leaderboard data for a campaign. It provides information such as player rankings, scores, and time played. Use this endpoint if you want to display a real-time leaderboard in your system to showcase player achievements and encourage competition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The ID of the campaign you want to retrieve the leaderboard for.

Query Params
int32
required

The number of leaderboard rows to return (min 1, max 500).

string

The ID of a specific player. If included, this player's leaderboard data is returned in the special me object in the response.

string
enum

The leaderboard sorting basis. Can be score or time. Defaults to score.

Allowed:
string

A timestamp in ISO8601 format. If included, only leaderboard entries from this date forward will be returned.

Responses

Updated 5 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago