Skip to main content
Version: Next

Charts

Create, read, update, and delete charts (slices).

MethodEndpointPath
DELETEBulk delete charts (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/
GETGet a list of charts/api/v1/chart/
POSTCreate a new chart/api/v1/chart/
GETGet metadata information about this API resource (chart--info)/api/v1/chart/_info
GETGet a chart detail information/api/v1/chart/{id_or_uuid}
DELETEDelete a chart (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/{pk}
PUTUpdate a chart/api/v1/chart/{pk}
GETCompute and cache a screenshot (chart-pk-cache-screenshot)/api/v1/chart/{pk}/cache_screenshot/
GETReturn payload data response for a chart/api/v1/chart/{pk}/data/
GETGet the sub-layer charts declared by a deck.gl Multiple Layers chart/api/v1/chart/{pk}/deck_layers/
DELETERemove the chart from the user favorite list/api/v1/chart/{pk}/favorites/
POSTMark the chart as favorite for the current user/api/v1/chart/{pk}/favorites/
GETGet a computed screenshot from cache (chart-pk-screenshot-digest)/api/v1/chart/{pk}/screenshot/{digest}/
GETGet chart thumbnail/api/v1/chart/{pk}/thumbnail/{digest}/
GETActivity stream — chart own edits + datasets the chart pointed at during association/api/v1/chart/{uuid_str}/activity/
GETReturn the version history for a chart/api/v1/chart/{uuid_str}/versions/
GETRead-only snapshot of the chart at a given version/api/v1/chart/{uuid_str}/versions/{version_uuid_str}/
POSTRevert a chart to an earlier version (non-destructive)/api/v1/chart/{uuid_str}/versions/{version_uuid_str}/restore
POSTPermanently delete a soft-deleted chart/api/v1/chart/{uuid}/purge
POSTRestore a soft-deleted chart/api/v1/chart/{uuid}/restore
POSTReturn payload data response for the given query (chart-data)/api/v1/chart/data
GETReturn payload data response for the given query (chart-data-cache-key)/api/v1/chart/data/{cache_key}
GETDownload multiple charts as YAML files/api/v1/chart/export/
GETCheck favorited charts for current user/api/v1/chart/favorite_status/
POSTImport chart(s) with associated datasets and databases/api/v1/chart/import/
GETGet related fields data (chart-related-column-name)/api/v1/chart/related/{column_name}
PUTWarm up the cache for the chart/api/v1/chart/warm_up_cache