compose_preview_v1_datasets__provider___dataset__compose_preview
Preview a single-join composition on a dataset without saving. Validates join cardinality and warns if results exceed limits.
Instructions
POST /v1/datasets/{provider}/{dataset}/compose/preview (auth: Bearer OPENDATA_API_KEY) — Preview a compose/join without saving it — Execute a single-join preview against provider/dataset.
Kept narrow: exactly one join spec per request. Multi-join composition would compound cardinality risk during preview — we want users to vet each join in isolation before they chain them.
Preflight: when the base dataset has more than
CARDINALITY_PREFLIGHT_BASE_ROW_THRESHOLD rows, we run a COUNT(*) on
the joined query first. If the count exceeds
CARDINALITY_PREFLIGHT_HARD_LIMIT we refuse with 400. If it's above
the dynamic warning threshold we still run the preview but emit a
cardinality_warning and cap rows at CARDINALITY_PREFLIGHT_ROW_CAP.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| provider | Yes | ||
| dataset | Yes | ||
| body | Yes | Request body (application/json) for POST /v1/datasets/{provider}/{dataset}/compose/preview |