Start a classroom analysis
Send a link to an audio recording of a lesson and start a job that transcribes it and scores the teaching against a rubric.
id. Save it: it is the only way to read the result.Rules
- Send
teacher_id,board_id,grade_id,subject_id,rubric_id,date, andlink.institution_idis optional. teacher_idandinstitution_idare your own identifiers, and must be 50 characters or fewer. The API stores them and does not check them.board_id,grade_id, andsubject_idmust be IDs that exist. Get them from List boards, List grades, and List subjects.rubric_idtakes either the rubric’s UUID from List rubrics or its integer ID. The rubric’s criteria become the categories in the result.dateis the day of the lesson, asYYYY-MM-DD. Today is allowed, a future date is rejected.linkmust start withhttps://, its path must end with.mp3in lower case, and the file must be publicly reachable.
How the link is checked
The API checks the link before it accepts the request:200, not 201, and the message field in the response is called message, not msg.Next step
Get a classroom analysis
class_track_analysis webhook.Authorizations
Access token from Get an access token. ClassTrack reads the Authorization header as the token itself, so send the token with no Bearer prefix on these two endpoints.
Body
Your own identifier for the teacher being observed. Stored as sent, and not checked against anything.
50The education board. Must exist. Get it from List boards.
The grade. Must exist. Get it from List grades.
The subject. Must exist. Get it from List subjects.
The rubric to score the lesson against. Send its UUID from List rubrics, or its integer ID. Either way the rubric must exist, and its criteria become the categories in rubric_evaluation.
The date of the lesson, as YYYY-MM-DD. Today is allowed. A future date is rejected.
A link to the recording. It must start with https://, its path must end with .mp3 in lower case, and it must be publicly reachable. Links to localhost or a private IP range are rejected.
Optional. Your own identifier for the school.
50Response
The job is queued. Save id: it is the only way to read the result. Note that this call returns 200, not 201, and that the message field is called message, not msg.