MEmetabase
/api/public

GET /api/public/card/{uuid}/query/{export-format}

Changed on

Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth credentials. Public sharing must be enabled.

get/api/public/card/{uuid}/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

uuidstring required

value must be a valid UUID.

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

Schema for valid export formats for downloading query results.

Query parameters

format_rowsboolean
pivot_resultsboolean
idstring required

Schema for a string that cannot be blank.

namestring

Schema for a string that cannot be blank.

sectionIdstring

Schema for a string that cannot be blank.

slugstring

Schema for a string that cannot be blank.

type'number' | 'text' | 'date' | 'boolean' | 'date/single' | 'id' | 'category' | 'location/city' | 'location/state' | 'location/zip_code' | 'location/country' | 'date/range' | 'date/month-year' | 'date/quarter-year' | 'date/relative' | 'date/all-options' | 'temporal-unit' | 'number/!=' | 'number/<=' | 'number/=' | 'number/>=' | 'number/between' | 'string/!=' | 'string/=' | 'string/contains' | 'string/does-not-contain' | 'string/ends-with' | 'string/starts-with' | 'boolean/='

Valid parameter :type

csv_include_bomboolean nullable

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

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • info

      added the new optional query request parameter csv_include_bom

    • info

      the query request parameter format_rows became optional

    • info

      the query request parameter pivot_results became optional

  • 78297d193ca4Revision changes
    • info

      api operation id get-api-public-card-uuid-query-export-format was added