GET
/
v1
/
trace-learn
/
privacy
/
retention
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.getTraceLearnPrivacyRetention()
{
  "generatedAt": "<string>",
  "learnerKeyRule": "<string>",
  "localSpillDefaults": {
    "personalDeviceTtlDays": 123,
    "sharedDeviceTtlDays": 123,
    "sharedDeviceMaxSessions": 123
  },
  "retentionPolicies": [
    {
      "id": "<string>",
      "label": "<string>",
      "owningDomain": "<string>",
      "defaultRetentionDays": 123,
      "hardTtlDays": 123,
      "pseudonymous": true,
      "containsChildPii": true,
      "retentionTableName": "<string>",
      "liveInV1": true,
      "notes": "<string>"
    }
  ],
  "piiGuards": [
    {
      "id": "<string>",
      "label": "<string>",
      "detail": "<string>"
    }
  ],
  "retentionCleanerIntegration": {
    "registeredTableNames": [
      "<string>"
    ],
    "pendingTableNames": [
      "<string>"
    ],
    "excludedFinancialAuditTables": [
      "<string>"
    ]
  }
}

Response

Success

generatedAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
learnerKeyRule
string
required
localSpillDefaults
object
required
retentionPolicies
object[]
required
piiGuards
object[]
required
retentionCleanerIntegration
object
required