Skip to main content
GET
/
v1
/
console
/
dropoff
/
stats
Get Aggregate Stats
curl --request GET \
  --url http://localhost:8000/v1/console/dropoff/stats \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "cards_basis": "<string>",
    "critical": {
      "count": 123,
      "pct_change": 123
    },
    "filters": {},
    "high": {
      "count": 123,
      "pct_change": 123
    },
    "medium": {
      "count": 123,
      "pct_change": 123
    },
    "thresholds": {
      "critical_score_cutoff": 123,
      "flagged_score_cutoff": 123,
      "high_score_cutoff": 123,
      "labels": [
        "critical",
        "high",
        "medium",
        "low"
      ],
      "model_threshold": 123
    },
    "total_flagged": {
      "count": 123,
      "pct_change": 123
    },
    "total_students": 123,
    "current_period": "2023-11-07T05:31:56Z",
    "previous_period": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your JWT access token

Query Parameters

faculty
string | null
programme
string | null
year
string | null

Programme level, e.g. 100L

cohort
string | null
risk_level
string | null

Accepted for symmetry; band cards always show the full breakdown

period
string<date-time> | null

Run timestamp; defaults to the latest run

Response

Successful Response

data
AggregateStats · object
message
string | null
success
boolean
default:true