API Reference¶
Audience is the developer authoring a custom QuickSight app on the tree primitives — the integrator role page is the upstream curated path.
Auto-generated reference for the Python API. The pages here cover the
primitives an external author would import to build a QuickSight app
against this codebase — the common/ package surface plus the
common/tree/ package which is the public construction API as of
Phase L.
The intended user is someone writing a new app on the tree (read the customization handbook walkthrough first for the worked-example narrative).
Three-layer model¶
The codebase is structured around three layers; the API surface documented here lives entirely in L1:
- L1 —
common/tree/+common/models.py+common/ids.py+common/dataset_contract.py. Persona-blind primitives. Knows about dashboards (sheets / visuals / filters / drills), nothing about banks / accounts / specific institutions. - L2 —
apps/<app>/app.py+apps/<app>/constants.py. Per-app tree assembly, in domain vocabulary. - **L3 — SQL strings +
apps/<app>/demo_data.py+common/persona.py - theme presets.** Persona / customer flavor.
When extending the API itself (rare), the L1 invariant is: zero hits
when you grep common/tree/ for any persona / institution name.