Execute query with transparent caching
Changed onExecute a query with transparent caching.
Compiles the resolved query to SQL, checks the cache for existing results, executes against the warehouse on cache miss, and stores the result for future requests. Cache failures are invisible to the caller.
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
Example request
{
"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)"
}
}Response
Successful Response
Changes
- breaking
the request property
became required - breaking
request property
list-of-types was narrowed by removing typesnullfrom media typeapplication/json
- breaking
- breaking
added the new required request property
//// - breaking
removed from the
///request propertyanyOflist - breaking
removed the enum value
area_chartof the request property/// - breaking
removed the enum value
bar_chartof the request property/// - breaking
removed the enum value
card_gridof the request property/// - breaking
removed the enum value
data_tableof the request property/// - breaking
removed the enum value
donut_chartof the request property/// - breaking
removed the enum value
gaugeof the request property/// - breaking
removed the enum value
heatmapof the request property/// - breaking
removed the enum value
imageof the request property/// - breaking
removed the enum value
key_value_listof the request property/// - breaking
removed the enum value
kpi_cardof the request property/// - breaking
removed the enum value
line_chartof the request property/// - breaking
removed the enum value
pie_chartof the request property/// - breaking
removed the enum value
scatter_chartof the request property/// - breaking
removed the enum value
single_valueof the request property/ - breaking
removed the enum value
stat_cardsof the request property/// - breaking
removed the enum value
staticof the request property/ - breaking
removed the enum value
styled_tableof the request property/// - breaking
removed the enum value
textof the request property/// - 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 - warning
removed the request property
/ - info
added the new optional request property
//// - info
added to the
///request propertyanyOflist - info
added the new
DATE[]enum value to the request property//// - info
added the new
FLOAT[]enum value to the request property//// - info
added the new
INT[]enum value to the request property//// - info
added the new
STRING[]enum value to the request property//// - info
added the new
axis_metric_by_dimensionenum value to the request property/// - info
added the new
axis_metric_by_dimensiondateenum value to the request property/// - info
added the new
axis_metric_by_dimensiondate_sliced_by_dimensionenum value to the request property/// - info
added the new
axis_scatter_plotenum value to the request property/// - info
added the new
dimension_dateenum value to the request property////// - info
added the new
funnelenum value to the request property/ - info
added the new
funnel_funnel_chartenum value to the request property/// - info
added the new
heatmap_heatmapenum value to the request property/// - info
added the new
imageenum value to the request property/ - info
added the new
image_image_gridenum value to the request property/// - info
added the new
image_single_imageenum value to the request property/// - info
added the new
kpi_cardenum value to the request property/ - info
added the new
kpi_measure_with_dimension_expressionenum value to the request property/// - info
added the new
kpi_measure_with_secondary_metricenum value to the request property/// - info
added the new
kpi_single_measure_compared_to_prev_period_sparklineenum value to the request property/// - info
added the new
kpi_single_valueenum value to the request property/// - info
added the new
pie_pie_chartenum value to the request property/// - info
added the new
table_data_tableenum value to the request property/// - info
added the new
table_fancy_subtotal_tableenum value to the request property/// - info
added the new
table_key_value_listenum value to the request property/// - info
added the new
table_styled_tableenum value to the request property/// - info
added the new
textenum value to the request property/ - info
added the new
text_data_readout_with_sparklineenum value to the request property/// - info
added the new
text_narrative_textenum value to the request property/// - info
request property
////list-of-types was widened by adding typesarrayto media typeapplication/json - info
request property
////list-of-types was widened by adding typesarrayto media typeapplication/json
- breaking