/data/line-items/dimensional-breakdown
Resolve a line-item name (e.g. revenue, net income) and return the dimensional breakdown of every consolidated fact that matches. Each match is one root with its axis-grouped slice facts. When the name matches more than one concept, matches come pre-ordered by Akkru smart ranking (same ordering as POST /data/line-items); the order is a recommendation only — review all matches and judge which one you need.
Filing selection: standard (filing_id or ticker + fiscal_year + form_type + optional quarter).
Request:
filing_idintegerconditionaltickerstringconditionalform_typestringDefault 10-K.
fiscal_yearintegerconditionalquarterstringline_itemstringrequiredA single line-item name (e.g. "revenue").
recursivebooleanDefault true.
detailstringDefault "full". Full and minimal views only: "light" returns the minimal view. See Response detail.
Response:
ticker, form_type, fiscal_year, quarter, source_url_prefixFiling identity.
matchesArray of {root, groups, duplicate_root_fact_ids?} entries.
matches[].rootSame shape as root in POST /data/facts/dimensional-breakdown, plus metric (echoes the request line_item) and _resolution_level ("L0"–"L3").
matches[].groupsSame shape and ordering as groups in POST /data/facts/dimensional-breakdown. Each fact also carries metric and _resolution_level.
matches[].duplicate_root_fact_idsOptional. Other fact_id values that resolved to the same logical fact as root.
_correctionOptional. Same shape as on POST /data/line-items.
_warningsOptional.
credits_usedResolver tier credit + ceil(N_total / 5) × 10, where N_total is the slice facts returned across all roots.
Member granularity within a group: Same as POST /data/facts/dimensional-breakdown — summary members and their detail components may coexist; summing all facts in one group can double-count.
Credits: Tiered resolution credit (L0=10 … L3=50) + ceil(N_total / 5) × 10. Partial billing applies.
Errors:
| HTTP | error_code | When |
|---|---|---|
| 400 | DATA_FILING_QUARTER_REQUIRED | Ambiguous quarterly filings. |
| 404 | DATA_FILING_NOT_FOUND | Filing not found. |
| 403 | PLAN_TIER_INSUFFICIENT_HISTORY, PLAN_TIER_INSUFFICIENT, PLAN_TIER_INSUFFICIENT_COVERAGE | The filing is outside your plan. Not charged. |
| 402 | CREDITS_INSUFFICIENT | Zero balance. |
| 422 | — | Validation. |