Reporting
Reporting
Explore the data types and operations available in Reporting.
41 operations
Archive a report from active authoring.
cancelReportRunMutationRequest cancellation of a report execution.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
dataChangeEventsSubscriptionSubscribe 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).
describeQuerySchemaQueryAnalyze 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.
generateDefaultDataQueryQueryGenerate 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.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getReportQueryRead a report and its draft metadata by ID.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery 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.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listReportsQueryList reports in a cursor-paginated page.
magicQueryQueryExecutes 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.
pauseReportScheduleMutationPause future firings of a report schedule.
pingQueryHealth check endpoint
previewReportMutationQueue a preview execution of an inline report definition.
publishReportMutationValidate and publish the current draft as an immutable version.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
reportArtifactsQueryList retained output files for a report run.
reportOccurrencesQueryList recorded firings of a report schedule.
reportQueryQueryExecute 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.
reportRunQueryRead the progress and outcome of a report run.
reportRunsQueryList report runs, optionally restricted to a published version.
reportSchedulesQueryList schedules pinned to a report version.
reportVersionQueryRead an immutable report version by ID.
reportVersionsQueryList published versions of a report.
retryReportRunMutationQueue another attempt of a failed report run.
runOneShotReportMutationExecute an inline report definition without publishing a reusable report.
runReportMutationQueue a run and return its durable ID immediately. Poll reportRun, then download reportArtifacts.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
sqlAuthoringSchemaQueryPermission-filtered MicroSQL authoring metadata and its content version. Contains logical schema only, never physical database mappings.
upsertReportDraftMutationCreate a report or replace its editable draft.
upsertReportScheduleMutationCreate or update a report schedule.
validateReportQueryCheck a report definition without saving or executing it.