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

Query parameters

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')

Changed in 2 of the 11 revisions of this API.312

Mar 5, 20266a140b82e07c311See the full diff
- ▲
  added the new required request property query_id
  new-required-request-property
- ▲
  the request property tenant_key became required
  request-property-became-required
- ▲
  request property tenant_key list-of-types was narrowed by removing types null from media type application/json
  request-property-list-of-types-narrowed
- ●
  removed the request property query_ref
  request-property-removed
- ○
  added the new optional request property pinned_variant
  new-optional-request-property
Feb 26, 2026bef1f3e205dd1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog