Admin - Schools

Get School Analytics

Changed on

Get comprehensive analytics for a school, for one school year, including all teachers and classes of that year. Only accessible by admin users.

get/admin/schools/{school_id}/analytics

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/{school_id}/analytics
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

school_idstring required

The ID of the school

Query parameters

weeksinteger
school_yearstring nullable

Response

Successful Response

school_idstring required
school_namestring required
school_domainstring nullable
total_teachersinteger required
total_classesinteger required
total_studentsinteger required
total_exercises_completedinteger required
total_homework_exercisesinteger required
total_teacher_examsinteger required
total_coursesinteger required
total_teacher_assignmentsinteger required
total_chat_wordsinteger required
total_time_spent_hoursnumber required
active_students_last_monthinteger required
weekly_activityobject required
weekly_homework_activityobject required
school_yearstring required
available_school_yearsstring[]
weeks_analyzedinteger required
analysis_start_datestring date-time required
analysis_end_datestring date-time required

Changes

  • 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

  • 8d495ed916c6Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property school_domain list-of-types was widened by adding types null to media type application/json of response 200