GET
/
v1
/
trace-learn
/
tutor
/
students
/
{studentId}
/
lesson-completions
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.getTraceLearnTutorStudentCompletions({
  studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? "studentId",
})
{
  "studentId": "<string>",
  "displayName": "<string>",
  "totalCompleted": 1,
  "passedCount": 1,
  "failedCount": 1,
  "completions": [
    {
      "id": "<string>",
      "studentId": "<string>",
      "lessonId": "<string>",
      "segmentId": "<string>",
      "lessonTitle": "<string>",
      "attemptNumber": 2,
      "status": "<string>",
      "passed": true,
      "scoreCorrect": 123,
      "scoreTotal": 123,
      "scorePercent": 50,
      "activeMs": 123,
      "startedAt": "<string>",
      "completedAt": "<string>"
    }
  ]
}

Path Parameters

studentId
string
required

Response

Success

studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
displayName
string
required
totalCompleted
integer
required

a non-negative number

Required range: x >= 0
passedCount
integer
required

a non-negative number

Required range: x >= 0
failedCount
integer
required

a non-negative number

Required range: x >= 0
completions
object[]
required