Chuyển tới nội dung chính

API Statistics

Tiền tố /api/v1/statistics. Controller: statistics.controller.ts. Module: statistics.

Danh sách route​

RouteAuthMô tả
GET /api/v1/statistics/admin-dashboardĐăng nhập, vai trò: SUPER ADMINSố liệu tổng hợp toàn hệ thống (quản trị viên)
GET /api/v1/statistics/hr-dashboardĐăng nhập, vai trò: HRSố liệu tổng hợp theo công ty của HR

Ghi chú​

  • admin-dashboard chỉ SUPER ADMIN, cache 15 phút. hr-dashboard chỉ HR (quản trị viên không gọi được), cache 3 phút theo công ty.
  • Cache nằm trong bộ nhớ tiến trình, nên số liệu có thể khác nhau giữa các instance (data-flow).
  • Cấu trúc phản hồi được định nghĩa bởi AdminDashboardStatsDto và HrDashboardStatsDto trong src/statistics/dto/; chưa liệt kê field ở đây. Xem Swagger để có ví dụ.

Chi tiết từng route​

GET /api/v1/statistics/admin-dashboard​

Số liệu tổng hợp toàn hệ thống (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: getAdminDashboardStats trong statistics.controller.ts
  • Mã thành công: 200, message = "Get admin dashboard statistics"

Phản hồi theo Swagger

MãMô tả
200Admin dashboard statistics retrieved successfully
401Unauthorized - Invalid or missing token

GET /api/v1/statistics/hr-dashboard​

Số liệu tổng hợp theo công ty của HR

  • Auth: Đăng nhập, vai trò: HR
  • Handler: getHrDashboardStats trong statistics.controller.ts
  • Mã thành công: 200, message = "Get HR dashboard statistics"

Phản hồi theo Swagger

MãMô tả
200HR dashboard statistics retrieved successfully
403Forbidden - HR account is not associated with a company