MEmetabase
/api/document

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

Changed on

Download query results for a Card embedded in a Document.

Returns query results in the requested format. The user must have read access to the document to download results. If the card's query fails, standard query error responses are returned.

Route parameters:

  • document-id: ID of the document containing the card
  • card-id: ID of the card to download results from
  • export-format: Output format (csv, xlsx, json)

Body parameters (snake_case):

  • parameters: Optional query parameters (array of maps or JSON string)
  • format_rows: Whether to apply formatting to results (boolean, default false)
  • pivot_results: Whether to pivot results (boolean, default false)
post/api/document/{document-id}/card/{card-id}/query/{export-format}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

document-idinteger required

value must be an integer greater than zero.

card-idinteger required

value must be an integer greater than zero.

export-formatstring required

Request body

format_rowsboolean

value must be a valid boolean string ('true' or 'false').

pivot_resultsboolean

value must be a valid boolean string ('true' or 'false').

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added subschema #2 to the request property anyOf list

    • info

      the request property became optional

    • info

      the request property became optional

  • 78297d193ca4Revision changes
    • info

      api operation id post-api-document-document-id-card-card-id-query-export-format was added