Skip to main content
POST
Error

Path Parameters

projectUuid
string
required

Body

application/json
sql
string
required
parameters
object

Construct a type with a set of properties K of type T

usePreAggregateCache
boolean
invalidateCache
boolean
context
enum<string>
Available options:
dashboardView,
autorefreshedDashboard,
exploreView,
filterAutocomplete,
chartView,
chartHistory,
sqlChartView,
sqlRunner,
viewUnderlyingData,
alert,
scheduledDelivery,
csvDownload,
gsheets,
scheduledGsheetsChart,
scheduledGsheetsDashboard,
scheduledGsheetsSqlChart,
scheduledChart,
scheduledDashboard,
calculateTotal,
calculateSubtotal,
embed,
ai,
mcp.run_metric_query,
mcp.run_sql,
mcp.search_field_values,
api,
cli,
metricsExplorer,
preAggregateMaterialization,
composeSqlRunner,
dataAppSample
references
object

Results of previous async queries exposed to the SQL as tables, keyed by table name: {"orders": ""} lets the SQL run SELECT * FROM orders. Each referenced query is authorized with the same access checks as fetching its results by uuid.

Typed Record<string, UUID> (not Record<string, string>) on purpose: TSOA compiles a string-valued record to an empty object literal and validation then strips every key; a ref-aliased value type keeps additionalProperties intact (and validates the uuid format).

limit
number<double>

Response

Success

results
object
required
status
enum<string>
required
Available options:
ok