charts operations

Generated from the shared operation catalog. Use the JSON catalog for complete input schemas. Required dependency checks can be stricter than the resource permission listed below.

chart_listCopy Anchor Link

List the saved charts, each with its encoding (mark, x, y, colour) and the id of the query it draws. Use chart_create to add one.

• HTTP: GET /api/charts
• SDK: client.charts.list(input)
• Access: workspace; chart / read
• Effect annotation: Read-only

chart_createCopy Anchor Link

Save a chart without running its query. For a visual flow, set queryId and spec.flowOutput to its chart node ID; read flow_catalog for the live contract. Otherwise set an encoding (mark, x, y, colour) whose fields are the query RESULT aliases, not assumed table columns. Derive them from the query definition or declared result schema; execute only if requested.

• HTTP: POST /api/charts
• SDK: client.charts.create(input)
• Access: workspace; chart / write
• Effect annotation: May change state or run effects

chart_readCopy Anchor Link

Read a saved chart, its query reference, and its renderer or flow output settings without executing the query.

• HTTP: GET /api/charts/:id
• SDK: client.charts.get(input)
• Access: workspace; chart / read
• Effect annotation: Read-only

chart_updateCopy Anchor Link

Update a chart title, encoding, or saved flow output reference. Use chart_read first. The same chart validation as the app applies; this does not run its query.

• HTTP: PATCH /api/charts/:id
• SDK: client.charts.update(input)
• Access: workspace; chart / write
• Effect annotation: May change state or run effects

chart_deleteCopy Anchor Link

Delete a saved chart. Check dashboards that contain it before deleting. Its source data remains unchanged.

• HTTP: DELETE /api/charts/:id
• SDK: client.charts.remove(input)
• Access: workspace; chart / admin
• Effect annotation: May change state or run effects; destructive operation