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חובה	integer	0–9007199254740991
studentsNewThisMonthחובה	integer	0–9007199254740991
attendanceRate30dחובה	number \| null	0–100
outstandingMinorחובה	integer	-9007199254740991–9007199254740991
currencyחובה	enum: "ILS" \| "USD" \| "EUR"	—
overdueCountחובה	integer	0–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? } }`. כל הקודים מפורטים במדריך המוסכמות.