Resolve query template
Changed onResolve a query template with user-selected parameters.
Takes a query reference and variable selections, returns the fully resolved query object ready for compilation.
RLS: Filtered to current client (ClientRLSDB).
Request
- Base URLhttps://api.kater.ai
- Auth
- HTTP bearer
- or API key in header X-API-Key
Query parameters
Headers
Request body
Response
Successful Response
Example response
{
"resolved_query": {
"chart_hints": [
{
"config": {
"color_by": "ref(created_date)",
"size": "ref(created_date)",
"stack_by": "ref(created_date)",
"x_axis": "ref(created_date)",
"y_axis": "ref(created_date)"
}
}
],
"filters": [
{
"exists": {
"from": "ref(dim_customer.sale_price)"
},
"not_exists": {
"from": "ref(dim_customer.sale_price)"
}
}
],
"resolved_chart": {
"config": {
"color_by": "ref(created_date)",
"size": "ref(created_date)",
"stack_by": "ref(created_date)",
"x_axis": "ref(created_date)",
"y_axis": "ref(created_date)"
}
},
"resolved_variables": [
{
"allowed_values": {
"from_column": "ref(dim_customer.sale_price)"
}
}
],
"select_from": [
{
"ref": "ref(dim_customer.sale_price)"
}
],
"source_query": "ref(dim_customer.sale_price)",
"topic": "ref(dim_customer.sale_price)"
}
}Changes
- breaking
added the new required request property
- warning
removed the request property
- info
added the new optional request property
- breaking
- breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response400 - breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response401 - breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response403 - breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response404 - breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response422 - breaking
response property
errorslist-of-types was widened by adding typesarrayto media typeapplication/jsonof response500 - breaking
response property
resolved_query/resolved_variables/anyOf[subschema #1]/items/bound_valuelist-of-types was widened by adding typesarrayto media typeapplication/jsonof response200 - breaking
response property
resolved_query/resolved_variables/anyOf[subschema #1]/items/defaultlist-of-types was widened by adding typesarrayto media typeapplication/jsonof response200 - warning
removed the optional property
/from the response with the status - warning
added the new
DATE[]enum value to the////response property for the response status - warning
added the new
FLOAT[]enum value to the////response property for the response status - warning
added the new
INT[]enum value to the////response property for the response status - warning
added the new
STRING[]enum value to the////response property for the response status - warning
added the new
axis_metric_by_dimensionenum value to the///response property for the response status - warning
added the new
axis_metric_by_dimensiondateenum value to the///response property for the response status - warning
added the new
axis_metric_by_dimensiondate_sliced_by_dimensionenum value to the///response property for the response status - warning
added the new
axis_scatter_plotenum value to the///response property for the response status - warning
added the new
dimension_dateenum value to the//////response property for the response status - warning
added the new
funnelenum value to the/response property for the response status - warning
added the new
funnel_funnel_chartenum value to the///response property for the response status - warning
added the new
heatmap_heatmapenum value to the///response property for the response status - warning
added the new
imageenum value to the/response property for the response status - warning
added the new
image_image_gridenum value to the///response property for the response status - warning
added the new
image_single_imageenum value to the///response property for the response status - warning
added the new
kpi_cardenum value to the/response property for the response status - warning
added the new
kpi_measure_with_dimension_expressionenum value to the///response property for the response status - warning
added the new
kpi_measure_with_secondary_metricenum value to the///response property for the response status - warning
added the new
kpi_single_measure_compared_to_prev_period_sparklineenum value to the///response property for the response status - warning
added the new
kpi_single_valueenum value to the///response property for the response status - warning
added the new
pie_pie_chartenum value to the///response property for the response status - warning
added the new
table_data_tableenum value to the///response property for the response status - warning
added the new
table_fancy_subtotal_tableenum value to the///response property for the response status - warning
added the new
table_key_value_listenum value to the///response property for the response status - warning
added the new
table_styled_tableenum value to the///response property for the response status - warning
added the new
textenum value to the/response property for the response status - warning
added the new
text_data_readout_with_sparklineenum value to the///response property for the response status - warning
added the new
text_narrative_textenum value to the///response property for the response status - info
added the new optional request property
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
////to the response with the status - info
added to the
///response propertyanyOflist for the response status - info
removed from the
///response propertyanyOflist for the response status - info
removed the
area_chartenum value from the///response property for the response status - info
removed the
bar_chartenum value from the///response property for the response status - info
removed the
card_gridenum value from the///response property for the response status - info
removed the
data_tableenum value from the///response property for the response status - info
removed the
donut_chartenum value from the///response property for the response status - info
removed the
gaugeenum value from the///response property for the response status - info
removed the
heatmapenum value from the///response property for the response status - info
removed the
imageenum value from the///response property for the response status - info
removed the
key_value_listenum value from the///response property for the response status - info
removed the
kpi_cardenum value from the///response property for the response status - info
removed the
line_chartenum value from the///response property for the response status - info
removed the
pie_chartenum value from the///response property for the response status - info
removed the
scatter_chartenum value from the///response property for the response status - info
removed the
single_valueenum value from the/response property for the response status - info
removed the
stat_cardsenum value from the///response property for the response status - info
removed the
staticenum value from the/response property for the response status - info
removed the
styled_tableenum value from the///response property for the response status - info
removed the
textenum value from the///response property for the response status - info
added the required property
////to the response with the status
- breaking