Get a classroom analysis

GET

class-track

analysis

{analysis_id}

cURL

curl https://api.crazygoldfish.com/class-track/v1/analysis/7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35 \
  -H "Authorization: YOUR_ACCESS_TOKEN"

import requests

# ClassTrack takes the token on its own, with no "Bearer " prefix
headers = {"Authorization": "YOUR_ACCESS_TOKEN"}
analysis_id = "7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35"

response = requests.get(
    f"https://api.crazygoldfish.com/class-track/v1/analysis/{analysis_id}",
    headers=headers,
)
response.raise_for_status()
body = response.json()

if "data" in body:
    result = body["data"]["result"]
else:
    print(body["detail"][0]["msg"])  # Analysis is In progress

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/class-track/v1/analysis/{analysis_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "id": "7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35",
      "msg": "Analysis is In progress"
    }
  ]
}

Step 2 of 2 in Analyze a classroom recording. Poll every 5 seconds until the body contains data.

This endpoint returns HTTP 200 even when the analysis is not finished, so the status code tells you nothing. Branch on the body instead: a data object means the analysis is ready, and a detail array means it is still running or it failed.

Reading the response

Response	Meaning	What to do
`200` with `detail[0].msg: "Analysis is In progress"`	Still transcribing or scoring	Poll again
`200` with `detail[0].msg: "Analysis is Failed"`	The job failed	Check the link is still reachable, then start a new analysis
`200` with `data`	Ready	Read `data.result` and `data.extracted_transcript`
`404` `Analysis with id ... not found`	No analysis with this ID. An ID that is not a UUID also returns `404`.	Check the ID from Start a classroom analysis
`401` `Unauthorized User`	The token is unreadable or expired, or you sent it with a `Bearer` prefix	Send the token on its own, with no prefix

The status values are In progress, Completed, and Failed. In progress has a lower-case p, unlike the other CrazyGoldFish APIs.

What the result contains

data.result has five parts:

Field	What it holds
`overall_teaching_score`	The overall level for the lesson, as text rather than a number
`summary`	A few sentences on what went well and what to work on
`rubric_evaluation`	One entry per criterion in the rubric you sent, each with `score`, `observations`, `recommendations`, and quotes in `examples`
`classroom_insights`	Observations on clarity, engagement, management, differentiation, assessment, and strengths
`action_plan`	`immediate_actions`, `short_term_goals`, and `long_term_development`

data.extracted_transcript is the recognized speech as one string. It comes from the transcription service in lexical form, so it has no punctuation or capitalization.

Instead of polling, register a webhook for class_track_analysis. See Async jobs and webhooks. Keep polling as a fallback: some failures mark the analysis Failed without sending the event.

Analyze a classroom recording

The full flow, with code you can run.

Authorizations

Authorization

string

header

required

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.

Path Parameters

analysis_id

string<uuid>

required

The id returned by Start a classroom analysis.

Example:

"7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35"

Response

Two different bodies share this status code. A data object means the analysis is finished. A detail array means it is still running or it failed.

Option 1
Option 2

Returned once the analysis is complete.

data

object

Show child attributes

cURL

curl https://api.crazygoldfish.com/class-track/v1/analysis/7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35 \
  -H "Authorization: YOUR_ACCESS_TOKEN"

import requests

# ClassTrack takes the token on its own, with no "Bearer " prefix
headers = {"Authorization": "YOUR_ACCESS_TOKEN"}
analysis_id = "7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35"

response = requests.get(
    f"https://api.crazygoldfish.com/class-track/v1/analysis/{analysis_id}",
    headers=headers,
)
response.raise_for_status()
body = response.json()

if "data" in body:
    result = body["data"]["result"]
else:
    print(body["detail"][0]["msg"])  # Analysis is In progress

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/class-track/v1/analysis/{analysis_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "id": "7f3c9a24-5b18-4d6e-9c07-2a4f8e1b6d35",
      "msg": "Analysis is In progress"
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get a classroom analysis

Reading the response

What the result contains

Analyze a classroom recording

Authorizations

Path Parameters

Response

​Reading the response

​What the result contains

​Related

Analyze a classroom recording

Authorizations

Path Parameters

Response

Reading the response

What the result contains

Related