Skip to main content
Version: Next

Charts

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

MethodEndpointPath
DELETEBulk delete charts/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
DELETEDelete a chart/api/v1/chart/{pk}
GETGet a chart detail information/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/
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}/
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