v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB

/api/dataset

POST /api/dataset/{export-format}

Execute a query and download the result data as a file in the specified format.

post/api/dataset/{export-format}

export-format'csv' | 'api' | 'xlsx' | 'json' required

Schema for valid export formats for downloading query results.

format_rowsboolean required

pivot_resultsboolean required

queryobject required

visualization_settingsobject required

Successful response

average_execution_timeinteger nullable

cachedstring nullable

{"stackTrail":"components:schemas:metabase.query-processor.schema.query-result:properties:context","oasType":"schema","type":"unknown"}

database_idinteger

Valid Database ID

errorstring

error_typestring

json_queryobject

row_countinteger required

running_timeinteger

started_atstring

status'completed' | 'failed' required