GET
/
v1
/
trace-learn
/
parent
/
children
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.listTraceLearnParentChildren()
[
  {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "targetSchool": "<string>",
    "overallScore": 50,
    "homeworkDueCount": 123,
    "lastActiveAt": "<string>",
    "predictedPassProbability": 0.5,
    "credential": {
      "username": "<string>",
      "pinSet": true,
      "credentialKind": "student_username_pin",
      "lastRotatedAt": "<string>"
    },
    "link": {
      "id": "<string>",
      "parentId": "<string>"
    }
  }
]

Response

Success

id
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
displayName
string
required
avatarId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
yearGroup
enum<string>
required
Available options:
Year 4,
Year 5,
Year 6
targetSchool
string | null
required
overallScore
number
required

a number between 0 and 100

Required range: 0 <= x <= 100
homeworkDueCount
number
required
lastActiveAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
predictedPassProbability
number
required

a number between 0 and 1

Required range: 0 <= x <= 1
credential
object
required