faction.stats

GET · api v1

Head counts for a قطاع: members by status, on vacation today and hired this week.

إحصائيات القطاع: الأعضاء حسب الحالة، اللي في إجازة اليوم، والمعيّنين هذا الأسبوع.

Parameters

NameTypeRequiredDescription
factionstringrequiredThe in-game job name linked to the قطاع, e.g. "police".

Returns (res.data)

NameTypeDescription
totalnumberAll members.
by_statustable{ active, on_vacation, resigned, terminated, retired }
hired_this_weeknumberNew hires since Monday.

Possible errors

Notes

Example

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

Example output

{
  "ok": true,
  "data": {
    "total": 48,
    "by_status": {
      "active": 41,
      "on_vacation": 3,
      "resigned": 2,
      "terminated": 1,
      "retired": 1
    },
    "hired_this_week": 2
  },
  "meta": {
    "action": "faction.stats",
    "method": "GET",
    "api": 1
  }
}