/api/card

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

Changed on

Run the query associated with a Card. When stored_result_id is supplied, serve the cached snapshot instead of re-running the query and optionally re-sorts the rows via the sort body param.

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

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

integer required

value must be an integer greater than zero.

OR
string required

String must be a valid 21-character NanoID string.

Request body

collection_previewboolean nullable
dashboard_idinteger nullable

value must be an integer greater than zero.

ignore_cacheboolean
sort'value_asc' | 'value_desc' | 'label_asc' | 'label_desc' nullable
stored_result_idinteger nullable

value must be an integer greater than zero.

Response

Successful response

Changes

    • breaking

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

    • breaking

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

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      the request property became optional

    • info

      api operation id post-api-card-card-id-query was added