GET
/
v1
/
trace-learn
/
tutor
/
dashboard
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.getTraceLearnTutorDashboard()
{
  "tutor": {
    "id": "<string>",
    "displayName": "<string>"
  },
  "cohortSize": 123,
  "students": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "avatarId": "<string>",
      "yearGroup": "<string>",
      "targetSchool": "<string>",
      "overallScore": 50,
      "streakDays": 123,
      "lastActiveAt": "<string>",
      "weakTopicNames": [
        "<string>"
      ],
      "strongTopicNames": [
        "<string>"
      ]
    }
  ],
  "assignments": [
    {
      "id": "<string>",
      "title": "<string>",
      "subjectName": "<string>",
      "questionCount": 123,
      "dueAt": "<string>",
      "dueLabel": "<string>",
      "timeLimitMinutes": 123,
      "assignedStudentIds": [
        "<string>"
      ]
    }
  ],
  "attention": [
    {
      "studentId": "<string>",
      "reason": "<string>"
    }
  ],
  "progress": {
    "dateRange": {
      "start": "<string>",
      "end": "<string>"
    },
    "points": [
      {
        "date": "<string>",
        "week": "<string>",
        "label": "<string>",
        "studentId": "<string>",
        "studentName": "<string>",
        "overall": 50,
        "maths": 50,
        "english": 50,
        "vr": 50,
        "nvr": 50
      }
    ]
  },
  "projectionFreshness": {
    "asOf": "<string>",
    "stale": true
  }
}

Response

Success

tutor
object
required
cohortSize
number
required
students
object[]
required
assignments
object[]
required
attention
object[]
required
progress
object
required
projectionFreshness
object
required