Get queries

GET/v1/queries

Get the most recent queries for a canvas cell, ordered from newest to oldest.

Parameters

NameInTypeDescription
canvas_keyrequiredquerystringThe unique identifier for the canvas
cell_keyrequiredquerystringThe unique identifier for a cell in a canvas
num_rowsquerystringThe number of rows to return in the result preview, up to 1,000.

Responses

Successful response

success * boolean
request_id * string
result * object
queries * object[] Recent queries
job_key * string The unique identifier for the query job
status * "running" | "completed" | "error" The current status of the job
error string The error returned during query execution.
results object[] URLs for query results in available formats (if completed).
format * "csv" | "parquet" | "arrow" The format of the query results at this URL
url * string A signed URL that can be used to download query results. This URL expires after 1 hour, after which a new URL can be requested using this route.
result_preview string A preview of the first rows of the results in CSV format (if completed). By default up to 50 rows are returned, unless otherwise specified in the num_rows option.
result_metadata object Metadata about the results (if completed)
columns object[] The columns in the result set
name * string The column name
type * "number" | "string" | "date" | "datetime" | "boolean" | "other" The column data type
duration number The total query duration in milliseconds
num_rows number The number of rows in the result set
row_limit number The row limit applied when extracting the results from the database
byte_limit number The byte limit applied when extracting the results from the database
sql string The executed SQL for this query (if available)