# Reports

Published reports, retained PDF/CSV outputs, runs and schedules.

## Operations

```graphql
# Reports (reports)
# Published reports, retained PDF/CSV outputs, runs and schedules.
# Read reports-guide; author a draft, preview, publish, then run or schedule.
# Query
analyzeReportSource: String!  # Analyze XML without executing queries; returns diagnostics and the live authoring vocabulary as JSON
compileSchemaXML: String!  # Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded
exportReportSource: String!  # Losslessly export a report definition as XML
generateDefaultDataQuery: String  # Generate a default GraphQL data query for an event topic
getMagicQueryGraphQL: MagicQueryOperation!  # Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL
getMagicQuerySchema: MagicQuerySchema!  # Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery
getReport: Report  # Read a report and its draft metadata by ID
helpChapter: HelpChapter  # Read a chapter of the current published manual edition
helpChapters: [HelpChapterInfo!]!  # List human-facing manual chapters from the running deployment
iacGuides: [IaCGuide!]!  # Every authoring guide, for a tool that syncs them to a folder
iacSchema: IaCSchemaDocument!  # The infrastructure-only view of this schema, for declarative tooling
iacSchemaDocument: IaCSchemaDocumentPayload!  # Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling
iacValidate: IaCValidationResult!  # Validate an infrastructure artifact
listDataChangeEventTopics: [DataChangeEventGroup!]!  # List all valid data change event topics, grouped by resource
listMagicQueries: [MagicQueryInfo!]!  # Lists every available Magic Query noun with a short description and its options — the discovery entry point
listReports: ReportConnection!  # List reports in a cursor-paginated page
magicQuery: JSON!  # Executes a Magic Query string and returns the predefined query's JSON result
ping: String!  # Health check endpoint
renderSchemaXML: String!  # Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document
reportArtifacts: [ReportArtifact!]!  # List retained output files for a report run
reportBuilderTables: [ReportBuilderTable!]!  # List report data sources and their selectable columns
reportDeliveries: [ReportDelivery!]!  # List notification delivery attempts for a report run
reportOccurrences: [ReportOccurrence!]!  # List recorded firings of a report schedule
reportRun: ReportRun  # Read the progress and outcome of a report run
reportRuns: ReportRunConnection!  # List report runs, optionally restricted to a published version
reportSchedules: [ReportSchedule!]!  # List schedules pinned to a report version
reportStarters: [ReportStarter!]!  # List starter definitions for creating reports
reportVersion: ReportVersion!  # Read an immutable report version by ID
reportVersions: [ReportVersion!]!  # List published versions of a report
schemaAuthoringCatalog: JSON!  # Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations
searchHelp: HelpSearchResult!  # Search human-facing manuals using shared semantic and text retrieval
validateReport: ReportValidationOutput!  # Check a report definition without saving or executing it
# Mutation
archiveReport: ReportPayload!  # Archive a report from active authoring
cancelReportRun: ReportRunPayload!  # Request cancellation of a report execution
pauseReportSchedule: ReportSchedulePayload!  # Pause future firings of a report schedule
previewReport: ReportRunPayload!  # Queue a preview execution of an inline report definition
publishReport: ReportVersionPayload!  # Validate and publish the current draft as an immutable version
publishReportSource: ReportPayload!  # Publish the specified report source with an exact-source precondition
retryReportRun: ReportRunPayload!  # Queue another attempt of a failed report run
runOneShotReport: ReportRunPayload!  # Execute an inline report definition without publishing a reusable report
runReport: ReportRunPayload!  # Queue a run and return its durable ID immediately
runReportBatch: ReportBatchPayload!  # Queue one run per parameter object under an idempotent batch key
upsertReportDraft: ReportPayload!  # Create a report or replace its editable draft
upsertReportSchedule: ReportSchedulePayload!  # Create or update a report schedule
upsertReportSource: ReportPayload!  # Create or replace a report draft using XML source
# Subscription
dataChangeEvents: DataChangeEvent!  # Subscribe to real-time data change events

# Call describe_operation(name) for arguments and input types.
```

## Exact schema

Download [complete SDL](/schemas/reports.graphql) (81644 bytes). Use the SDL to validate operations; the digest omits argument signatures.

## Guides