MEmetabase
/api/card

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

Changed on

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

csv_include_bom, 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}

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

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

csv_include_bomboolean

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

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 the new optional request property

    • 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-card-card-id-query-export-format was added