reports

Reports

Cross-module reporting endpoints — today the consolidated manager dashboard (roster, attendance rate, outstanding balance, overdue invoices, today’s sessions).

1 نقاط النهاية

GET /api/v1/dashboard

Consolidated manager dashboard: active/new students, 30-day attendance rate, outstanding balance, overdue invoice count, and today’s sessions.

يتطلّب المصادقةالصلاحيةreports.read

مثال بأمر curl

curl
curl -X GET "https://your-institute.example/api/v1/dashboard" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY"

الاستجابات

200
الاسمالنوعالقيود
studentsActiveمطلوب
integer0–9007199254740991
studentsNewThisMonthمطلوب
integer0–9007199254740991
attendanceRate30dمطلوب
number | null0–100
outstandingMinorمطلوب
integer-9007199254740991–9007199254740991
currencyمطلوب
enum: "ILS" | "USD" | "EUR"—
overdueCountمطلوب
integer0–9007199254740991
todaySessionsمطلوب
array<object>—
json
{
  "studentsActive": 0,
  "studentsNewThisMonth": 0,
  "attendanceRate30d": 0,
  "outstandingMinor": -9007199254740991,
  "currency": "ILS",
  "overdueCount": 0,
  "todaySessions": [
    {
      "id": "37386ae0-3738-7738-8386-37386ae03738",
      "groupName": "string",
      "start": "2026-03-02T09:00:00.000Z",
      "room": "string"
    }
  ]
}
400The request could not be read at all — unparseable body, unusable content type, oversized payload (`MALFORMED_REQUEST`). Never a schema failure: those are 422.

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

401Missing, expired or invalid credentials (`UNAUTHORIZED`, `TOKEN_INVALID`, `SESSION_REVOKED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

402The tenant’s subscription or license is locked (`PAYMENT_REQUIRED`, `SUBSCRIPTION_SUSPENDED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

403Authenticated, but not allowed (`FORBIDDEN`, `FEATURE_DISABLED`, `QUOTA_EXCEEDED`, …).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

404No such resource, or it is not visible to this tenant (`NOT_FOUND`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

409Conflicts with current state (`CONFLICT`, `VERSION_CONFLICT`, `IDEMPOTENCY_KEY_REUSED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

422The request was read but its content is not acceptable: body/query/path/header failed schema validation (`VALIDATION_ERROR`, with `details.issues`), or a domain rule rejected a well-formed value (`VIDEO_URL_INVALID`, …).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

429Rate limit exceeded — see the `RateLimit-*` and `Retry-After` headers (`RATE_LIMITED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

500Unexpected server error (`INTERNAL_ERROR`). Never carries a stack trace or SQL.

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.