report | GraphQL reference

report

returns Report

Single report definition with structures + entity name.

Arguments

Name	Type	Description
reportId	String!	The report's id.

Returns Report

Report definition summary — header metadata, no facts. Returned by create-report, regenerate-report, file-report, and transition-filing-status. Use the package read endpoint to retrieve a Report rehydrated with its rendered InformationBlockEnvelope items.

Field	Type	Description
id	String!	Report identifier (ULID).
name	String!	Human-readable report name.
taxonomyId	String!	Taxonomy this report renders against.
generationStatus	String!	Computation lifecycle: `generating`, `published`, `failed`. Orthogonal to `filingStatus`.
periodType	String!	Period cadence: `monthly`, `quarterly`, `annual`.
periodStart	Date	Current-period start.
periodEnd	Date	Current-period end.
comparative	Boolean!	True when an auto-generated prior-period column is included.
periods	[PeriodSpec!]	Explicit period columns when the report was created with a multi-period layout.
mappingId	String	CoA → taxonomy mapping the facts were rolled up through.
aiGenerated	Boolean!	True when the report was created by an AI agent rather than a user.
createdAt	DateTime!	When the report row was created.
lastGenerated	DateTime	When the facts were last (re)generated.
structures	[StructureSummary!]!	Structures available for this report's taxonomy — renderable sections (BS / IS / CF / Equity / Schedules).
entityName	String	Display name of the primary entity the report is tagged to.
filingStatus	String!	Filing lifecycle (orthogonal to `generationStatus`): `draft`, `under_review`, `filed`, `archived`.
filedAt	DateTime	When the report was transitioned to `filed`. On a report shared in from another graph this is the sender's filing time, carried over with `filingStatus` so a recipient can tell a draft they were sent from final statements.
filedBy	String	User ID that transitioned the report to `filed`. Always null on a report shared in from another graph: the sender's user id resolves to nobody in the recipient's graph, so it is deliberately not carried across with `filingStatus` and `filedAt`.
supersedesId	String	When this report restates an earlier filing, the predecessor's report ID.
supersededById	String	When this report has been restated, the successor's report ID.
sourceGraphId	String	Origin graph for received (shared) reports — populated only on the recipient's copy.
sourceReportId	String	Origin report ID for received (shared) reports — populated only on the recipient's copy.
sharedAt	DateTime	When the report was shared into this graph (recipient side).
ruleSummary	JSON	Counts by rule outcome (e.g. `{'passed': 12, 'failed': 1}`) from the most recent evaluation. Null until rules run.

Example

query

{ report(reportId: "...") { id name taxonomyId generationStatus } }

curl

curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ report(reportId: \"...\") { id name taxonomyId generationStatus } }"}'