v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-051387180.3 KB

compiler

Preview a single combination with live data

Preview a single combination: resolve, compile, execute, and build config.

Chains existing services to provide a single-call preview for the query gallery. Returns data + WidgetConfig for immediate rendering.

RLS: Filtered to current client (ClientRLSDB).

post/api/v1/compiler/combination/preview

sourcestring nullable

X-Kater-CLI-IDstring nullable

combinationstring required

Comma-separated slot selections, same format as ResolveRequest.combination. Example: 'dimension=due_month,measure=compliance_rate'

connection_idstring uuid required

Connection to preview against

pinned_variantstring nullable

Optional pinned variant name (e.g. '_base').

query_idstring uuid required

UUID of the query template

tenant_keystring required

Tenant key for multi-tenant execution. Use 'kater_global_tenant' for no-tenancy clients.

Successful Response

auto_titlestring nullable

Auto-generated title

cache_hitboolean

Whether the result was served from cache

configobject

Resolved WidgetConfig (from config builder)

dataobject[]

Query result rows

execution_time_msnumber

Total execution time in milliseconds

successboolean required

Whether preview succeeded

widget_typestring nullable

Resolved widget type (e.g. 'axis_metric_by_dimensiondate')

All 13 operations