GET
/
v1
/
trace-learn
/
parent
/
reports
/
{reportId}
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.getTraceLearnParentReport({
  reportId: process.env.TX_AGENT_KIT_REPORT_ID ?? "reportId",
})
{
  "id": "<string>",
  "student": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "yearGroup": "<string>",
    "targetSchool": "<string>"
  },
  "title": "<string>",
  "periodStart": "<string>",
  "periodEnd": "<string>",
  "generatedAt": "<string>",
  "tutorName": "<string>",
  "predictedPassProbability": 0.5,
  "timeStudiedSeconds": 123,
  "improvements": [
    {
      "metric": "<string>",
      "before": "<string>",
      "after": "<string>",
      "delta": "<string>"
    }
  ],
  "topicMastery": [
    {
      "id": "<string>",
      "name": "<string>",
      "score": 50
    }
  ],
  "narrative": {
    "positive": "<string>",
    "causeHypothesis": "<string>",
    "systemResponse": "<string>"
  },
  "actionItems": [
    "<string>"
  ],
  "projectionFreshness": {
    "asOf": "<string>",
    "stale": true
  }
}

Path Parameters

reportId
string
required

Response

Success

id
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
student
object
required
title
string
required
periodStart
string
required

a string at least 10 character(s) long

Minimum string length: 10
periodEnd
string
required

a string at least 10 character(s) long

Minimum string length: 10
generatedAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
tutorName
string
required
reviewState
enum<string>
required
Available options:
ready_to_share,
tutor_review_required
predictedPassProbability
number
required

a number between 0 and 1

Required range: 0 <= x <= 1
timeStudiedSeconds
number
required
improvements
object[]
required
topicMastery
object[]
required
narrative
object
required
actionItems
string[]
required
projectionFreshness
object
required