Skip to main content

BadgeLeaderboard

Returns the badge leaderboard for the learners of the instance. The results of this query can be affected by providing an authToken header to set a user for the operation.

BadgeLeaderboard(
  limit: Int
): BadgeLeaderboard!

Directives​

authAccess​

This requires the current user to be in STUDENT role.

Arguments​

BadgeLeaderboard.limit ● Int scalar​

Type​

BadgeLeaderboard object​

Examples​

Run in Postman

Query:​

BadgeLeaderboard($limit: Int) {
 BadgeLeaderboard(limit: $limit) {
   awardType {
     ...AwardTypeFragment
   }
   leaders {
     ...BadgeLeaderFragment
   }
   currentUserPosition {
     ...BadgeLeaderFragment
   }
 }
}

Variables:​

{
 "limit": 678
}

Response:​

{
  "data": {
    "BadgeLeaderboard": {
      "awardType": "AwardType",
      "leaders": [
        "BadgeLeader"
      ],
      "currentUserPosition": "BadgeLeader"
    }
  }
}