MEmetabase
/api/exploration

POST /api/exploration/{id}/summary/append

Changed on

Append a static cardEmbed representing a composite chart — built from one or more ExplorationQuery snapshots combined into a single qp-result — to the exploration's Summary document.

The body :exploration_query_ids is the FE-rendered SeriesGroup's full set (one entry for single-query charts; multiple for combined cartesian / heat-map charts). The BE combines those source snapshots (metabase.explorations.composite/combine) into one ephemeral stored_result and materializes one ephemeral report_card referencing it. The cardEmbed node remains single-card.

  • chart_href / child_target_id / host_data are written onto the node so the FE can deep-link the embed title back to the source page, share that page's comment stream (child_target_id), and resolve highlight hover and explore-further filter pills via opaque host_data.
  • display / visualization_settings are required FE-computed render settings (from buildSeries / getDisplay); the BE bakes them onto the ephemeral card.

All source EQs must belong to a thread of this exploration. Appending clears is_placeholder when it was set.

post/api/exploration/{id}/summary/append

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

idinteger required

value must be an integer greater than zero.

Request body

displaystring required
exploration_query_idsinteger[] required
visualization_settingsobject required

Value must be a map.

Response

Successful response

archivedboolean
content_typestring required
created_atstring date-time required

value must be a valid date/time/datetime

creator_idinteger required

value must be an integer greater than zero.

exploration_idinteger required

value must be an integer greater than zero.

idinteger required

value must be an integer greater than zero.

is_placeholderboolean required
namestring required
updated_atstring date-time required

value must be a valid date/time/datetime

Changes