GET
/
v1
/
trace-learn
/
tutor
/
parent-reports
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.listTraceLearnParentReports({
  query: {},
})
{
  "reports": [
    {
      "draftId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "studentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "studentDisplayName": "<string>",
      "window": {
        "startsAt": "<string>",
        "endsAtExclusive": "<string>"
      },
      "windowLabel": "<string>",
      "currentPayloadVersion": 123,
      "emailSubject": "<string>",
      "needsReview": true,
      "updatedAt": "<string>"
    }
  ],
  "needsReviewCount": 123
}

Query Parameters

status
enum<string>
Available options:
generating,
needs_review,
approved,
sent,
delivery_issue,
failed

Response

Success

reports
object[]
required
needsReviewCount
number
required