Skip to content

JSON types

CLI-level envelope: see Output contract.

Common data shapes

ApplicationListItem

json
{
  "appId": "string",
  "appName": "string",
  "agentStatus": "online | offline | unknown",
  "onlineInstanceCount": 0,
  "totalInstanceCount": 0
}

PolicyValidateResult

json
{
  "valid": true,
  "errors": [{ "path": "spec.sampling.rate", "message": "..." }],
  "warnings": []
}

ReplayPlanCreated

json
{
  "planId": "string",
  "result": 1,
  "desc": "string"
}

ReplayProgress

json
{
  "planId": "string",
  "status": "RUNNING | FINISHED | FAILED | CANCELLED",
  "percent": 0,
  "finished": false
}

TraceSummary

json
{
  "traceId": "string",
  "endpoint": "string",
  "status": "string",
  "durationMs": 0,
  "startedAt": "ISO-8601",
  "attrs": { "orderId": "ORD-123" }
}

ArtifactResult

json
{
  "artifact": "relative/path.json",
  "summary": {}
}

PaginatedList

json
{
  "items": [],
  "page": 1,
  "pageSize": 20,
  "total": 0,
  "hasMore": false
}

Backend passthrough

When --include-backend (optional debug flag) is set, implementers may add data._backend with the raw Response.body or CommonResponse.data.

Agents should not depend on _backend in production skills.

schemaVersion

Future CLI releases may add top-level "schemaVersion": 1 in the envelope. Agents must ignore unknown top-level fields.