Saving and publishing through the API

Reports can also be managed through the GraphQL API, for integrations and AI assistants. Pass report XML as a GraphQL variable; saving keeps its comments and formatting. XML is the sole authoring format: use upsertReportSource with sourceXML, the name, and the observed revision for updates. Previews use the parameter values you supply and your own data permissions.

Operation	Purpose
upsertReportSource	Save a draft from its XML, keeping comments and formatting.
analyzeReportSource	Return editing suggestions and errors without generating files.
exportReportSource	Convert a JSON report definition to XML.
previewReport	Run a draft with given parameters and keep the files as previews.
publishReport	Publish the saved draft as a new version.
runReport	Start a run of a published version; returns the run ID straight away.
runReportBatch	Start runs of one version for 1 to 100 parameter sets.
runOneShotReport	Run supplied XML (sourceXML) once, without adding it to your reports.
reportRun	Read a run's status.
reportArtifacts	List a finished run's files and their download links.
retryReportRun	Retry a run with its captured data, while it is kept.
cancelReportRun	Stop a run as soon as it safely can.
archiveReport	Stop new runs and schedules of a report.
reportStarters	List the starter reports.
upsertReportSchedule	Create or change a schedule.
pauseReportSchedule	Stop a schedule's future runs.
reportSchedules	List schedules and their progress.
reportOccurrences	List scheduled runs, including skipped ones.
reportDeliveries	List notification delivery attempts and their results.