Admin - Schools

Get All Schools Analytics

Changed on

Get aggregated analytics for all schools, for one school year. Returns summary statistics and per-school breakdowns. Only accessible by admin users.

get/admin/schools/analytics/all

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/schools/analytics/all
  • Auth: OAuth 2 (password, token URL api/login)

Query parameters

weeksinteger
school_yearstring nullable

Response

Successful Response

total_schoolsinteger required
total_schools_in_trialinteger required
total_schools_in_pilotinteger required
total_schools_paidinteger
total_schools_expiredinteger
total_teachersinteger required
total_studentsinteger required
total_exercises_completedinteger required
total_homework_exercisesinteger required
total_chat_wordsinteger required
total_active_students_last_monthinteger required
total_active_teachers_last_monthinteger
total_billed_studentsinteger
total_pending_studentsinteger
teachers_by_segmentobject
school_yearstring required
available_school_yearsstring[]
weeks_analyzedinteger required
analysis_start_datestring date-time required
analysis_end_datestring date-time required

Changes

  • a0b4ce9a0d8fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

  • e75413b9576aRevision changes
    • info

      added the new optional query request parameter school_year

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status