Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cors-lau.vercel.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Dashboard API provides a single endpoint that aggregates system-wide KPIs from the database and the ML model evaluation artifacts. Use it to populate a summary view, monitor data completeness, and track model quality over time.

GET /dashboard/metrics

Returns a snapshot of key performance indicators for the current state of the CORS system.

How the metrics are computed

FieldWhat it reflects
total_coursesTotal courses in your uploaded course catalog
total_offeringsTotal historical enrollment records across all semesters and campuses
latest_run_idID of the most recently completed prediction run (null if none)
average_model_confidenceROC-AUC score of the ML model associated with the latest run, as a percentage
average_fail_ratioGlobal average failure rate across all historical offering records, as a percentage
total_predictionsNumber of courses scored in the latest prediction run
total_recommended_offeringsNumber of courses marked offer = true in the latest run
average_model_confidence is only populated after you have run at least one prediction. If no prediction run exists, or if models need retraining, call POST /predict/train and then run a new analysis via POST /predict/bulk.

Responses

total_courses
integer
Total number of validated course records in the catalog.
total_offerings
integer
Total number of historical enrollment records across all semesters and campuses.
latest_run_id
integer
ID of the most recent prediction run. null if no prediction run has been created yet.
average_model_confidence
number
ROC-AUC score of the campus model associated with the latest prediction run, expressed as a percentage. Example: 82.3 means 82.3% AUC. Returns 0 if no model artifact is found.
average_fail_ratio
number
Global historical course failure rate as a percentage, averaged across all offering records. Example: 18.7 means 18.7% of enrolled students historically fail.
total_predictions
integer
Total number of course entries scored in the latest prediction run. 0 if no run exists.
Number of courses in the latest run that received an offer = true recommendation. 0 if no run exists.
curl https://your-cors-instance.com/dashboard/metrics \
  -H "Authorization: Bearer eyJ..."