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.getTraceLearnStudentDashboard(){
"student": {
"id": "<string>",
"displayName": "<string>",
"avatarId": "<string>",
"yearGroup": "<string>",
"targetSchool": "<string>"
},
"overallScore": 50,
"streakDays": 123,
"homework": [
{
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
}
],
"subjects": [
{
"name": "<string>",
"icon": "<string>",
"score": 50,
"questionsCompleted": 123,
"totalQuestions": 123
}
],
"weakTopics": [
{
"id": "<string>",
"name": "<string>",
"score": 50
}
],
"strongTopics": [
{
"id": "<string>",
"name": "<string>",
"score": 50
}
],
"recentActivity": [
{
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"score": 50,
"durationSeconds": 123,
"occurredAt": "<string>"
}
],
"analyticsProgress": {
"weekly": [
{
"label": "<string>",
"score": 50,
"questions": 123
}
],
"daily": [
{
"date": "<string>",
"label": "<string>",
"score": 50,
"questions": 123
}
]
},
"rewardState": {
"streakDays": 123,
"starsEarned": 123,
"earnedSeconds": 123,
"spentSeconds": 123,
"availableSeconds": 123,
"dailyCapSeconds": 123
},
"games": [
{
"name": "<string>",
"description": "<string>",
"unlocked": true,
"isNew": true,
"unlockTopic": "<string>"
}
],
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Trace Learn
Trace learn student dashboard
GET
/
v1
/
trace-learn
/
students
/
me
/
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.getTraceLearnStudentDashboard(){
"student": {
"id": "<string>",
"displayName": "<string>",
"avatarId": "<string>",
"yearGroup": "<string>",
"targetSchool": "<string>"
},
"overallScore": 50,
"streakDays": 123,
"homework": [
{
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
}
],
"subjects": [
{
"name": "<string>",
"icon": "<string>",
"score": 50,
"questionsCompleted": 123,
"totalQuestions": 123
}
],
"weakTopics": [
{
"id": "<string>",
"name": "<string>",
"score": 50
}
],
"strongTopics": [
{
"id": "<string>",
"name": "<string>",
"score": 50
}
],
"recentActivity": [
{
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"score": 50,
"durationSeconds": 123,
"occurredAt": "<string>"
}
],
"analyticsProgress": {
"weekly": [
{
"label": "<string>",
"score": 50,
"questions": 123
}
],
"daily": [
{
"date": "<string>",
"label": "<string>",
"score": 50,
"questions": 123
}
]
},
"rewardState": {
"streakDays": 123,
"starsEarned": 123,
"earnedSeconds": 123,
"spentSeconds": 123,
"availableSeconds": 123,
"dailyCapSeconds": 123
},
"games": [
{
"name": "<string>",
"description": "<string>",
"unlocked": true,
"isNew": true,
"unlockTopic": "<string>"
}
],
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Response
Success
Show child attributes
Show child attributes
a number between 0 and 100
Required range:
0 <= x <= 100Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I