Reporting

Reports

Explore the data types and operations available in Reports.

44 types · Used in operation arguments and return values.

BooleanScalar

The `Boolean` scalar type represents `true` or `false`.

DataChangeEventObject

A real-time data change event delivered via subscription

DataChangeEventGroupObject

A group of data change event topics for a single resource

HelpChapterObject

Published manual content for the Help reader.

HelpChapterInfoObject

Metadata for a published manual chapter.

HelpSearchResultObject

Hybrid semantic and text manual search results.

IaCGuideObject

An authoring guide, as a document with a stable file name. The same guides the MCP server serves, exposed so declarative tooling can sync them to a folder beside the schema.

IaCSchemaDocumentObject

The annotated infrastructure schema and the hash that pins it

IaCSchemaDocumentPayloadObject

A schema or Lua testing contract document and the hash that pins it

IaCValidationResultObject

Result of validating one artifact

IntScalar

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSONScalar

Arbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.

MagicQueryInfoObject

A discoverable Magic Query noun and its accepted options.

MagicQueryOperationObject

The real GraphQL operation + variables a Magic Query resolves to.

MagicQuerySchemaObject

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

QueryScalarScalar

A URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.

ReportObject

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

ReportArtifactObject

A retained output file produced by a report run.

ReportBatchInputInput

Queue a pinned report version once for each supplied parameter object.

ReportBatchPayloadObject

Result of a report batch mutation, with validation errors when rejected.

ReportBuilderTableObject

A data source offered by the report authoring interface.

ReportConnectionObject

A cursor-paginated page of reports.

ReportDeliveryObject

Notification delivery state for a completed report run.

ReportDraftInputInput

Save an editable report definition; omit id to create a report.

ReportIDScalar

Opaque identifier for a report.

ReportOccurrenceObject

The outcome of one intended schedule firing.

ReportOneShotInputInput

An inline report definition and parameters for one execution without publishing a reusable report.

ReportPayloadObject

Result of a report mutation, with validation errors when rejected.

ReportRunObject

A durable execution of a pinned report version, including progress and retention state.

ReportRunConnectionObject

A cursor-paginated page of report runs.

ReportRunIDScalar

Opaque identifier for a report run.

ReportRunPayloadObject

Result of a report run mutation, with validation errors when rejected.

ReportScheduleObject

An enabled or paused schedule for executing a pinned report version.

ReportScheduleIDScalar

Opaque identifier for a report schedule.

ReportScheduleInputInput

Create or update a report schedule with a timezone and execution principal.

ReportSchedulePayloadObject

Result of a report schedule mutation, with validation errors when rejected.

ReportSourceInputInput

XML report replacement save, with explicit source and name.

ReportStarterObject

An example definition that can be copied into a new report draft.

ReportValidationOutputObject

Static validation results for a report definition; validation does not execute it.

ReportVersionObject

An immutable published report definition that runs and schedules pin by ID.

ReportVersionIDScalar

Opaque identifier for a published report version.

ReportVersionPayloadObject

Result of a report version mutation, with validation errors when rejected.

RunReportInputInput

A pinned report version and parameter values to execute.

StringScalar

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.