GET
/
v1
/
trace-learn
/
tutor
/
analytics
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.getTraceLearnTutorAnalytics()
{
  "tutorId": "<string>",
  "generatedAt": "<string>",
  "cohortSize": 123,
  "thresholds": {
    "inactivityDays": 123,
    "overdueToleranceDays": 123,
    "recentSubmissionWindow": 123
  },
  "students": [
    {
      "studentId": "<string>",
      "displayName": "<string>",
      "avatarId": "<string>",
      "yearGroup": "<string>",
      "daysSinceLastActivity": 123,
      "outstandingAssignmentCount": 123,
      "overdueAssignmentCount": 123,
      "recentAverageScorePercent": 50,
      "scoreTrendPointDelta": 123,
      "weakestTopic": {
        "topicId": "<string>",
        "topicName": "<string>",
        "masteryPercent": 50
      },
      "reasonDetail": "<string>"
    }
  ],
  "projectionFreshness": {
    "asOf": "<string>",
    "stale": true
  }
}

Response

Success

tutorId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
generatedAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
cohortSize
number
required
thresholds
object
required
students
object[]
required
projectionFreshness
object
required