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.getTraceLearnTutorAssignmentDetail({
assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? "assignmentId",
}){
"assignment": {
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
},
"summary": {
"assignedCount": 123,
"completedCount": 123,
"completionRatePercent": 50,
"classAveragePercent": 50,
"averageTimeSeconds": 123,
"flaggedQuestionCount": 123
},
"targetStudents": [
{
"id": "<string>",
"displayName": "<string>",
"avatarId": "<string>",
"yearGroup": "<string>",
"targetSchool": "<string>",
"overallScore": 50
}
],
"attempts": [
{
"attemptId": "<string>",
"studentId": "<string>",
"studentName": "<string>",
"avatarId": "<string>",
"startedAt": "<string>",
"submittedAt": "<string>",
"scorePercent": 50,
"correctCount": 123,
"questionCount": 123,
"totalTimeSeconds": 123,
"questionAttempts": [
{
"questionId": "<string>",
"selectedAnswerIndex": 123,
"selectedAnswerLabel": "<string>",
"correctAnswerIndex": 123,
"correctAnswerLabel": "<string>",
"isCorrect": true,
"timeSeconds": 123,
"flagged": true
}
]
}
],
"questions": [
{
"order": 123,
"question": {
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"correctAnswerIndex": 123,
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
},
"redHerring": "<string>"
}
],
"reviewState": {
"canPublish": true,
"canSendReminders": true,
"canRequestRedo": true,
"lastReviewedAt": "<string>"
},
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Trace Learn
Trace learn tutor assignment detail
GET
/
v1
/
trace-learn
/
tutor
/
assignments
/
{assignmentId}
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.getTraceLearnTutorAssignmentDetail({
assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? "assignmentId",
}){
"assignment": {
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
},
"summary": {
"assignedCount": 123,
"completedCount": 123,
"completionRatePercent": 50,
"classAveragePercent": 50,
"averageTimeSeconds": 123,
"flaggedQuestionCount": 123
},
"targetStudents": [
{
"id": "<string>",
"displayName": "<string>",
"avatarId": "<string>",
"yearGroup": "<string>",
"targetSchool": "<string>",
"overallScore": 50
}
],
"attempts": [
{
"attemptId": "<string>",
"studentId": "<string>",
"studentName": "<string>",
"avatarId": "<string>",
"startedAt": "<string>",
"submittedAt": "<string>",
"scorePercent": 50,
"correctCount": 123,
"questionCount": 123,
"totalTimeSeconds": 123,
"questionAttempts": [
{
"questionId": "<string>",
"selectedAnswerIndex": 123,
"selectedAnswerLabel": "<string>",
"correctAnswerIndex": 123,
"correctAnswerLabel": "<string>",
"isCorrect": true,
"timeSeconds": 123,
"flagged": true
}
]
}
],
"questions": [
{
"order": 123,
"question": {
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"correctAnswerIndex": 123,
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
},
"redHerring": "<string>"
}
],
"reviewState": {
"canPublish": true,
"canSendReminders": true,
"canRequestRedo": true,
"lastReviewedAt": "<string>"
},
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Path Parameters
Response
Success
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