faction.leaderboard

GET · api v1

The top members of a leaderboard panel.

أعلى الأعضاء في لوحة المتصدرين.

Parameters

NameTypeRequiredDescription
factionstringrequiredThe in-game job name linked to the قطاع, e.g. "police".
panelnumberoptionalPanel id from the dashboard; default is the قطاع's first panel.
limitnumberoptional1 to 25, default 10.

Returns (res.data)

NameTypeDescription
paneltable{ id, title }
entriestable[]{ rank, discord_id, name, code, value } — value is the final score in percent.

Possible errors

Notes

Example

local res = exports.OrcaBot_V3:Get('faction.leaderboard', { faction = 'police', limit = 5 })

Example output

{
  "ok": true,
  "data": {
    "panel": {
      "id": 3,
      "title": "ساعات الأسبوع"
    },
    "entries": [
      {
        "rank": 1,
        "discord_id": "381234567890123456",
        "name": "فهد العتيبي",
        "code": "P-12",
        "value": 96.5
      }
    ]
  },
  "meta": {
    "action": "faction.leaderboard",
    "method": "GET",
    "api": 1
  }
}