v12

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

POST /api/card/{card-id}/query/{export-format}

Run the query associated with a Card, and return its results as a file in the specified format.

parameters, pivot-results? and format-rows? should be passed as application/x-www-form-urlencoded form content or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use HTML form actions).

post/api/card/{card-id}/query/{export-format}

Path parameters

card-idinteger required

value must be an integer greater than zero.

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

Schema for valid export formats for downloading query results.

Request body

format_rowsboolean required
parametersobject[] nullable
pivot_resultsboolean required

Response

Successful response