Audience: application and coding agent.
Coverage and source scope
Use this route to compare a disclosed segment metric across recent annual or quarterly filings. Selectmetric first, then use segment_type when the workflow needs a product, geographic, or other dimension. Rows preserve the issuer’s reported axes, members, units, reporting periods, and filing provenance; a missing segment or unsupported capability is not a zero value. Keep the returned accession, filing URL, and freshness fields with any analysis. See API conventions and freshness and source evidence.
Required metric and disclosure limits
Supply one issuer identifier and the requiredmetric. Use period and segment_type to narrow the requested history, and use limit, segment_limit, and submission_file_limit to bound the returned filings, segment rows, and inspected SEC submission files.
Segment dimensions and hierarchy reflect what the issuer disclosed. Read capability state and trace references before aggregating rows; an absent segment, unsupported metric, or unavailable hierarchy is not a zero value or a complete geographic/product split.
Related guides
Business breakdown workflow
Use reported segment dimensions with explicit coverage caveats.
Coverage and depth
Check what source detail is available before building a comparison.
Canonical metadata
requestIdtraceparentprovenancefreshnessmaterialization
Example request
Example response
About this example
This response is illustrative: the issuer, accession, segment members, andexample.com URL are synthetic. It aligns a geographic annual revenue record with the request and does not claim a live SEC filing.
Give this prompt to your agent
Failure posture
- provide one issuer identifier and the required
metric; keeplimitcontrols bounded for a predictable response - treat unsupported metrics, absent segment rows, or unavailable hierarchy as unavailable disclosure, not zero-valued segments
- preserve capability state, trace references, provenance, freshness, materialization,
requestId, andtraceparentwhen handling a partial or transient result

