POST
/
v1
/
trace-learn
/
experiments
/
{experimentKey}
/
{revision}
/
resolve
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.resolveTraceLearnExperiment({
  experimentKey: process.env.TX_AGENT_KIT_EXPERIMENT_KEY ?? "experimentKey",
  revision: process.env.TX_AGENT_KIT_REVISION ?? "revision",
  body: {},
})
{
  "assignmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "opportunityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variant": "<string>",
  "definitionHash": "<string>",
  "manifestHash": "<string>",
  "payload": {},
  "controlPayload": {}
}

Path Parameters

experimentKey
string
required
revision
string
required

a string to be decoded into a number

Body

application/json
eligibilityReference
object
required

Response

Success

assignmentId
string<uuid> | null
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}$
opportunityId
string<uuid> | null
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}$
variant
string
required
source
enum<string>
required
Available options:
assigned,
paused_control,
ineligible_control,
fallback_control
definitionHash
string
required

a string at least 1 character(s) long

Minimum string length: 1
manifestHash
string | null
required

a string at least 1 character(s) long

Minimum string length: 1
payload
object
required
controlPayload
object
required