SysListLeaderboardConfigs

Returns list of applicable leaderboards, with summary leaderboard configuration information, including tournament flags, if applicable. Option 'filterType' defaults to 'standard', with additional supported filter types of 'all', 'tournament', 'divisions' and 'templates'.

Service	Operation
leaderboard	SYS_LIST_LEADERBOARD_CONFIGS

Method Parameters

Parameter

Description

optionsJson

Supports filtering of returned list of leaderboard configs. Option 'filterType' defaults to 'standard' if not specified. Valid filterType values include 'all', 'standard', 'tournament', 'divisions' and 'templates'. If 'tournament' is specified, returned list will include leaderboards configured for tournaments, but excludes division set instances and templates. If 'division', returned list will include division set tournament leaderboard instances. If 'templates', returned list will include leaderboards flagged as division template only.

Usage

http://localhost:3000

C#

//cloud code only

C++

//cloud code only

Objective-C

//cloud code only

Java

//cloud code only

JavaScript

//cloud code only

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var optionsJson = {
      "filterType": "standard"
    };

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.sysListLeaderboardConfigs(optionsJson);

Raw

{
    "service": "leaderboard",
    "operation": "SYS_LIST_LEADERBOARD_CONFIGS",
    "data": {
    "optionsJson": {
      "filterType": "standard"
    }
    }
}

JSON Response

{
  "data": {
    "leaderboardList": [
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {
          "street": "1309 Carling"
        },
        "resetAt": 1631822069172,
        "currentVersionId": 2,
        "rotationType": "DAILY",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "aLeaderboardId"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": 1631740020000,
        "currentVersionId": 210,
        "rotationType": "DAILY",
        "leaderboardType": "ARCADE_HIGH",
        "leaderboardId": "arcadelb1"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": 1631740140000,
        "currentVersionId": 216,
        "rotationType": "DAILY",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "daily"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": null,
        "currentVersionId": 3,
        "rotationType": "ADHOC",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "l1"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": null,
        "currentVersionId": 2,
        "rotationType": "ADHOC",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "l2"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": null,
        "currentVersionId": 1,
        "rotationType": "ADHOC",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "l3"
      },
      {
        "entryType": "PLAYER",
        "numDaysToRotate": 0,
        "data": {},
        "resetAt": 1631825100000,
        "currentVersionId": 31,
        "rotationType": "WEEKLY",
        "leaderboardType": "HIGH_VALUE",
        "leaderboardId": "weekly"
      }
    ],
    "leaderboardListCount": 10
  },
  "status": 200
}