GitHub user dosubot[bot] added a comment to the discussion: Is there an API in
Superset to retrieve chart structure for chart creation?
<!-- Answer -->
Yes, you can retrieve the chart's params field (the JSON parameters used for
that chart) using a few indirect API methods, but only for existing charts—not
as a generic template per viz_type.
- The GET /api/v1/chart/{id_or_uuid} endpoint returns all details for a
specific chart, including the params field with the chart's configuration as
JSON. This is the most direct way to get the params for any existing chart by
its ID or UUID [(source)](https://github.com/apache/superset/pull/29573).
- If you want to get params for all charts on a dashboard, you can use GET
/api/v1/dashboard/{id_or_slug}/charts, which returns a list of charts (and
their params) for that dashboard
[(source)](https://github.com/apache/superset/blob/master/superset/dashboards/api.py).
- You can also export dashboards using GET /api/v1/dashboard/export/, which
includes all associated charts and their params in the exported YAML files
[(source)](https://github.com/apache/superset/blob/master/superset/dashboards/api.py).
There is no API that returns a generic or default chart params structure for a
given viz_type—these APIs only return params for charts that already exist.
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot).*
---
<sup>How did I do?
[Good](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=great_response)
|
[Irrelevant](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=irrelevant_answer)
|
[Incorrect](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=incorrect_sources)
|
[Verbose](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=too_verbose)
|
[Hallucination](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=hallucination)
| [Report
🐛](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=bug_report)
|
[Other](https://app.dosu.dev/response-feedback/ff0cc5fe-0434-4e12-a660-a2e0034d81ca?feedback_type=other)</sup> [](https://app.dosu.dev/a28d3c7e-a9d3-459e-9fb6-3a6f9ff4f357/ask?utm_source=github)&
nbsp;[](https://go.dosu.dev/discord-bot) [](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/discussions/35978)
GitHub link:
https://github.com/apache/superset/discussions/35978#discussioncomment-14867728
----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
