Skip to main content

EvaluationStatusEnvelope

okbooleanrequired
meta object
watermarkstring

Opaque leak-tracing token. Safe to ignore.

Possible values: Value must match regular expression ^wm_[0-9a-f]{8}$

Example: wm_a1b2c3d4
data object
statusstringrequired

Possible values: [pending, processing, complete, error]

total_scenariosintegerrequired
completedintegerrequired
scenarios object[]
  • Array [
  • idstringrequired
    namestringrequired
    scoreintegerrequired

    Possible values: >= 0 and <= 100

    violationsintegerrequired
    criticalintegerrequired
    compliance_gapsstring[]required

    Distinct framework controls that currently fail, formatted as "SOC 2 CC6.1".

    module_violations object[]required
  • Array [
  • module_idstringrequired
    module_namestringrequired
    module_typestringrequired
    Example: google-sheets:updateRow
    badgestringrequired

    Possible values: [critical, high, medium, low, pass]

    violation_countintegerrequired
    policiesstring[]required
  • ]
  • ]
  • errorstring

    Present only when status == "error".

    EvaluationStatusEnvelope
    {
    "ok": true,
    "meta": {
    "watermark": "wm_a1b2c3d4"
    },
    "data": {
    "status": "pending",
    "total_scenarios": 0,
    "completed": 0,
    "scenarios": [
    {
    "id": "string",
    "name": "string",
    "score": 0,
    "violations": 0,
    "critical": 0,
    "compliance_gaps": [
    "string"
    ],
    "module_violations": [
    {
    "module_id": "string",
    "module_name": "string",
    "module_type": "google-sheets:updateRow",
    "badge": "critical",
    "violation_count": 0,
    "policies": [
    "string"
    ]
    }
    ]
    }
    ],
    "error": "string"
    }
    }