Reporting

Reporting

Explore the data types and operations available in Reporting.

41 operations

archiveReportMutation

Archive a report from active authoring.

cancelReportRunMutation

Request cancellation of a report execution.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

describeQuerySchemaQuery

Analyze a MicroSQL query and return the inferred result schema (column names, data types) without executing it. Returns validation errors with typo-correcting suggestions if the query is invalid. Validates only against tables the caller can list.

generateDefaultDataQueryQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.

getMagicQueryGraphQLQuery

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. Does not execute.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getReportQuery

Read a report and its draft metadata by ID.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listReportsQuery

List reports in a cursor-paginated page.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.

pauseReportScheduleMutation

Pause future firings of a report schedule.

pingQuery

Health check endpoint

previewReportMutation

Queue a preview execution of an inline report definition.

publishReportMutation

Validate and publish the current draft as an immutable version.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

reportArtifactsQuery

List retained output files for a report run.

reportOccurrencesQuery

List recorded firings of a report schedule.

reportQueryQuery

Execute a MicroSQL reporting query against the analytics schema. Supports SELECT with WHERE, JOIN, ORDER BY, GROUP BY, LIMIT. Tenant isolation is enforced automatically. Covers production (jobs, components, operations, milestones), prepress, scheduling (work_centers, planned_operations, schedule_allocations), sales (estimates, orders, invoices), cost accounting, catalog/inventory (products, substrates, warehouse_stock), logistics (shipments), tasks, time-series (metric_points, progress_points), and people (users, teams). Per-table IAM authorization is enforced — requires :list on each table's resource.

reportRunQuery

Read the progress and outcome of a report run.

reportRunsQuery

List report runs, optionally restricted to a published version.

reportSchedulesQuery

List schedules pinned to a report version.

reportVersionQuery

Read an immutable report version by ID.

reportVersionsQuery

List published versions of a report.

retryReportRunMutation

Queue another attempt of a failed report run.

runOneShotReportMutation

Execute an inline report definition without publishing a reusable report.

runReportMutation

Queue a run and return its durable ID immediately. Poll reportRun, then download reportArtifacts.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

sqlAuthoringSchemaQuery

Permission-filtered MicroSQL authoring metadata and its content version. Contains logical schema only, never physical database mappings.

upsertReportDraftMutation

Create a report or replace its editable draft.

upsertReportScheduleMutation

Create or update a report schedule.

validateReportQuery

Check a report definition without saving or executing it.