GET
/
v1
/
trace-learn
/
parent
/
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.getTraceLearnParentDashboard()
{
  "parent": {
    "id": "<string>",
    "displayName": "<string>"
  },
  "children": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "avatarId": "<string>",
      "targetSchool": "<string>",
      "overallScore": 50,
      "homeworkDueCount": 123,
      "lastActiveAt": "<string>",
      "streakDays": 123,
      "predictedPassProbability": 0.5
    }
  ],
  "reports": [
    {
      "id": "<string>",
      "studentId": "<string>",
      "title": "<string>",
      "periodStart": "<string>",
      "periodEnd": "<string>",
      "generatedAt": "<string>"
    }
  ],
  "projectionFreshness": {
    "asOf": "<string>",
    "stale": true
  }
}

Response

Success

parent
object
required
children
object[]
required
reports
object[]
required
projectionFreshness
object
required