compiler

Preview a single combination with live data

Changed on

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

Request

  • Base URL
    https://api.kater.ai
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

sourcestring nullable

Headers

X-Kater-CLI-IDstring nullable

Request body

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.

Response

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

Changes

    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      endpoint added