RoboLedger: Analytical Views

Information Block

One section of a report read whole — the expensive call: rows in presentation order with the consolidated value per period column, the same rows broken out by the section's own axes, the axes with the members that carry facts, every total's calculation children with a footing check, and the section's text blocks. Member breakdowns and period columns are kept most-reported / most-recent first up to a response budget; a row is never left blank by a cut, and members_omitted / periods_omitted say what was. A block longer than max_rows is truncated; pass its next_offset as offset for the next page. Take block from disclosures. Same resolution as disclosures: ticker or report_id on shared-repo graphs, report_id on tenant graphs. On a tenant graph this reads the section as the ledger's report holds it; get-information-block returns one authored block's envelope with its rules and verification.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

post/extensions/roboledger/{graph_id}/operations/information-block

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/information-block
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

tickerstring nullable

Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.

report_idstring nullable

Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.

fiscal_yearinteger nullable

Narrow auto-resolution to this fiscal year focus

period_typestring nullable

Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)

blockstring required

The block id from disclosures (a role name or its last segment also resolves)

periodsstring[] nullable

Period keys to keep, from a previous call's columns. Default keeps the budgeted set, year and balance columns first on an annual form.

memberstring nullable

Keep only breakdowns whose member key contains this text (a segment name)

max_rowsinteger nullable

Cap on presentation rows (default 400)

max_membersinteger nullable

An explicit cap on member breakdowns, instead of the response budget

offsetinteger nullable

Rows to skip: the next_offset a truncated response returned

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Changes

No recorded changes to this operation across all 1 revision of this API.