GET
/
v1
/
trace-learn
/
tutor
/
parent-reports
/
{draftId}
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.getTraceLearnParentReportDraft({
  draftId: process.env.TX_AGENT_KIT_DRAFT_ID ?? "draftId",
})
{
  "draftId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "studentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "studentDisplayName": "<string>",
  "window": {
    "startsAt": "<string>",
    "endsAtExclusive": "<string>"
  },
  "windowLabel": "<string>",
  "calendarId": "england-lambeth-council-2026-27-v1",
  "currentPayload": {
    "version": 123,
    "emailSubject": "<string>",
    "emailBodyDocument": {
      "version": 1,
      "blocks": [
        {
          "type": "paragraph",
          "children": [
            {
              "type": "text",
              "text": "<string>",
              "bold": true,
              "italic": true
            }
          ]
        }
      ]
    },
    "editedByTutor": true,
    "createdAt": "<string>"
  },
  "payloadVersions": [
    {
      "version": 123,
      "emailSubject": "<string>",
      "emailBodyDocument": {
        "version": 1,
        "blocks": [
          {
            "type": "paragraph",
            "children": [
              {
                "type": "text",
                "text": "<string>",
                "bold": true,
                "italic": true
              }
            ]
          }
        ]
      },
      "editedByTutor": true,
      "createdAt": "<string>"
    }
  ],
  "facts": {
    "activitiesCompleted": 123,
    "lessonsCompleted": 123,
    "scoredActivities": 123,
    "averageScorePercent": 123,
    "bestScorePercent": 123,
    "activeStudySeconds": 123,
    "starsEarned": 123,
    "strengths": [
      {
        "topicLabel": "<string>"
      }
    ],
    "focusTopics": [
      {
        "topicLabel": "<string>"
      }
    ],
    "dataFreshAt": "<string>"
  },
  "generations": [
    {
      "generationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence": 123,
      "fallbackReason": "<string>",
      "temporalWorkflowId": "<string>",
      "createdAt": "<string>",
      "creditUsage": {
        "reservedCostDecimillicents": 123,
        "actualCostDecimillicents": 123
      }
    }
  ],
  "decisions": [
    {
      "decisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payloadVersion": 123,
      "note": "<string>",
      "createdAt": "<string>"
    }
  ],
  "sends": [
    {
      "sendId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payloadVersion": 123,
      "createdAt": "<string>",
      "failureReason": "<string>"
    }
  ],
  "recipient": {
    "parentDisplayName": "<string>",
    "email": "<string>",
    "deliveryAllowed": true,
    "blockedReason": "<string>"
  },
  "budgetSummary": {
    "budget": 123,
    "committed": 123,
    "remaining": 123,
    "periodStart": "<string>",
    "periodEnd": "<string>"
  },
  "isApprovalCurrent": true,
  "aiChangesAvailable": true
}

Path Parameters

draftId
string
required

Response

Success

draftId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
studentProfileId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
studentDisplayName
string
required
reportKind
enum<string>
required
Available options:
progress,
end_of_term
window
object
required
windowLabel
string
required
calendarId
enum<string> | null
required
Available options:
england-lambeth-council-2026-27-v1
presentationStatus
enum<string>
required
Available options:
generating,
needs_review,
approved,
sent,
delivery_issue,
failed
currentPayload
object
required
payloadVersions
object[]
required
facts
object
required
generations
object[]
required
decisions
object[]
required
sends
object[]
required
recipient
object
required
budgetSummary
object
required
isApprovalCurrent
boolean
required
aiChangesAvailable
boolean
required