← All resources

Resource

report

A reusable report with an editable draft and immutable published versions.

GraphQL reference →

Configuration

publishedSourcereport_documentOptional

Report document, including its sources and outputs.

report_document fields

Open model reference →

The root element: a report's parameters, data sources, preparation and output files. Save and publish a version before running or scheduling it.

object
definitionOptional
outputsOptional
parametersOptional
preparationScriptOptional
schemaVersionOptional

Version of the report format. Only 1 is supported.

integer
snapshotRetentionDaysOptional

Days to keep the data captured for each run, so a failed run can be retried or rendered again; 1 to 3650.

integer
sourcesOptional
tablePlanOptional
transformsOptional
All of these apply
Choose exactly one shape
outputsRequired
definitionRequired

Only the fields listed here are accepted.

written by `publishReportSource`, not by this resource's update

sourcereport_documentRequired

Report document, including its sources and outputs.

report_document fields

Open model reference →

The root element: a report's parameters, data sources, preparation and output files. Save and publish a version before running or scheduling it.

object
definitionOptional
outputsOptional
parametersOptional
preparationScriptOptional
schemaVersionOptional

Version of the report format. Only 1 is supported.

integer
snapshotRetentionDaysOptional

Days to keep the data captured for each run, so a failed run can be retried or rendered again; 1 to 3650.

integer
sourcesOptional
tablePlanOptional
transformsOptional
All of these apply
Choose exactly one shape
outputsRequired
definitionRequired

Only the fields listed here are accepted.

nameString!Required

Human-readable report name.

Read-only values

Show values
revisionInt!Read only

Monotonic authoring revision; changes on draft saves and publication.

computed by the platform

idReportID!Read only

Opaque identifier of this resource.

computed by the platform

currentVersionIdReportVersionIDRead only

Published version currently selected for this report; null before first publication.

computed by the platform

hasDraftBoolean!Read only

Whether an editable definition exists independently of the published version.

computed by the platform

sourceXMLStringRead only

Exact authored draft XML, if present.

computed by the platform

draftDefinitionStringRead only

Editable definition JSON; null after publication.

computed by the platform

archivedBoolean!Read only

Whether the report has been archived from active authoring.

computed by the platform

createdAtString!Read only

Creation timestamp in ISO 8601 format.

computed by the platform

updatedAtString!Read only

Last modification timestamp in ISO 8601 format.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.