GET
/
v1
/
trace-learn
/
admin
/
experiments
/
{experimentKey}
/
{revision}
/
report
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.getTraceLearnAdminExperimentReport({
  experimentKey: process.env.TX_AGENT_KIT_EXPERIMENT_KEY ?? "experimentKey",
  revision: process.env.TX_AGENT_KIT_REVISION ?? "revision",
})
{
  "experimentKey": "<string>",
  "revision": 123,
  "status": "<string>",
  "hypothesis": "<string>",
  "definitionHash": "<string>",
  "primaryMetricKey": "<string>",
  "targetSampleSize": 123,
  "assigned": {
    "control": 123,
    "treatment": 123,
    "total": 123
  },
  "exposed": {
    "control": 123,
    "treatment": 123,
    "total": 123
  },
  "missingOutcomes": {
    "control": 123,
    "treatment": 123,
    "total": 123
  },
  "outcomeReadiness": {
    "observed": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "pendingWindow": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "matureMissing": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "observationWindowComplete": true,
    "invalidValues": 123
  },
  "sampleRatioMismatch": {
    "controlAssigned": 123,
    "treatmentAssigned": 123,
    "expectedPerArm": 123,
    "chiSquare": 123,
    "pValue": 123,
    "mismatch": true
  },
  "arms": [
    {
      "variant": "<string>",
      "allocation": 123,
      "assigned": 123,
      "exposed": 123,
      "matureMissingOutcomes": 123
    }
  ],
  "armSampleRatioMismatch": {
    "arms": [
      {
        "variant": "<string>",
        "assigned": 123,
        "expected": 123
      }
    ],
    "degreesOfFreedom": 123,
    "chiSquare": 123,
    "pValue": 123,
    "mismatch": true
  },
  "baselineBalance": {
    "numeric": [
      {
        "key": "<string>",
        "result": {
          "available": true,
          "controlMean": 123,
          "treatmentMean": 123,
          "standardizedMeanDifference": 123
        }
      }
    ],
    "categorical": [
      {
        "key": "<string>",
        "result": {
          "available": true,
          "categories": [
            {
              "category": "<string>",
              "controlCount": 123,
              "controlProportion": 123,
              "treatmentCount": 123,
              "treatmentProportion": 123,
              "absoluteDifference": 123
            }
          ],
          "maximumAbsoluteDifference": 123
        }
      }
    ],
    "severeImbalance": true
  },
  "versionDrift": true,
  "versionEvidence": [
    {
      "dimension": "<string>",
      "control": [
        "<string>"
      ],
      "treatment": [
        "<string>"
      ],
      "drift": true
    }
  ],
  "guardrails": [
    {
      "key": "<string>",
      "stopThreshold": 123,
      "controlValue": 123,
      "treatmentValue": 123,
      "effect": 123,
      "observed": {
        "control": 123,
        "treatment": 123,
        "total": 123
      }
    }
  ],
  "intentToTreat": {
    "observed": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "missing": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "estimate": {
      "available": true,
      "metricType": "binary",
      "controlRate": 123,
      "treatmentRate": 123,
      "absoluteEffect": 123,
      "confidenceInterval95": {
        "lower": 123,
        "upper": 123
      }
    }
  },
  "exposureOnly": {
    "observed": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "missing": {
      "control": 123,
      "treatment": 123,
      "total": 123
    },
    "estimate": {
      "available": true,
      "metricType": "binary",
      "controlRate": 123,
      "treatmentRate": 123,
      "absoluteEffect": 123,
      "confidenceInterval95": {
        "lower": 123,
        "upper": 123
      }
    }
  },
  "fallbackEvidence": {
    "available": false,
    "reason": "durable_ledger_unavailable"
  },
  "bktModelVersions": [
    "<string>"
  ],
  "automaticWinner": null
}

Path Parameters

experimentKey
string
required
revision
string
required

a string to be decoded into a number

Response

Success

experimentKey
string
required
revision
number
required
status
string
required
hypothesis
string
required
definitionHash
string
required
primaryMetricKey
string
required
targetSampleSize
number
required
assigned
object
required
exposed
object
required
missingOutcomes
object
required
outcomeReadiness
object
required
sampleRatioMismatch
object
required
arms
object[]
required
armSampleRatioMismatch
object
required
baselineBalance
object
required
versionDrift
boolean
required
versionEvidence
object[]
required
guardrails
object[]
required
intentToTreat
object
required
exposureOnly
object
required
fallbackEvidence
object
required
evidenceState
enum<string>
required
Available options:
collecting,
valid,
insufficient_evidence,
harm
bktModelVersions
string[]
required
automaticWinner
null
required