Clear API Reference
  • Developer Reference
  • Getting Started
    • Authentication
    • Content Launch
    • Single Sign-On
  • Guides
    • Account Provisioning and Launch
  • Experience API Reference
    • Statements
    • State
    • Activity Profile
    • Agent Profile
  • Clear API Reference
    • Introduction
    • Data Model
      • Actor
      • Criteria
    • Authentication
    • Actors
    • Reports
    • Leaderboards
    • Search
    • Notifications
    • Import
Powered by GitBook
On this page
  1. Clear API Reference

Leaderboards

Get Leaderboard Standings

GET https://{organisation}.clearlrs.com/api/leaderboards

Pulls leaderboard rankings for the specified leaderboard activity.

Query Parameters

Name
Type
Description

activityId

string

The leaderboard activity to retrieve current standings.

limit

number

Sets the number of rankings that should be returned (defaults to 10)

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}
{    "message": "Ain't no cake like that."}

PreviousReportsNextSearch

Last updated 3 years ago