Skip to content

Reference

Report schema

report.json v1, generated from the JSON Schema that the engine validates every report against.

Every report the engine ships validates against this schema (packages/schema/json/report.schema.json, generated from Zod and checked for drift in CI). Numbers in text are {{N…}} placeholders that resolve to facts; every fact carries its computation (SQL with parameters, or a function and its inputs) and citations; every claim carries citations and a causal grade.

FieldRequiredTypeNotes
schemayesstring
job_idyesstring
generated_atyesstring
engineyesobject
periodyesobject
objectiveyesobject
sourcesyesarray
metricsyesarray
assumptionsyesarray
data_qualityyesarray
summaryyesobject
findingsyesarray
recommendationsyesarray
open_questionsyesarray
factsyesarray
verificationyesobject
evidencenoarray
rolesnoarray
table_kindsnoarray
business_modelnoobject

The complete schema: report.schema.json. The fixture packages/schema/test/fixtures/report.coffee-roaster.json is a full example.