Superset API 图像导出指南:轻松分享仪表板可视化数据

作者:API传播员 · 2025-10-18 · 阅读时间:3分钟
本文详细介绍了如何使用Superset的API导出仪表板图像功能,包括API端点、请求方法、有效载荷和响应格式。通过提供的cURL命令示例,用户可以快速掌握如何将可视化数据见解导出为图像,便于分享和分发。

一. 了解 Superset 的图像导出功能

Superset 提供通过 API 导出仪表板和图表图像的功能,非常适合快速分发可视化数据见解。借助该功能,用户可以将关键图表生成 PNG、JPEG 等图像格式,便于报告、演示或自动化数据共享。


二. API 端点

  • 端点地址:使用 /api/v1/chart/export/ 访问 Superset API 的图像导出功能。
  • 图表 ID:在请求中必须提供目标图表的唯一 ID,以指定要导出的图表。

三. 请求方法

  • 方法类型:通过 POST 请求发送 API 调用,同时在请求头中附加必要的身份验证信息(如 Bearer Token 或其他授权方式)。

四. 有效载荷

在请求正文中,需要提供一些关键参数:

  • dashboard_id / chart_id:指定要导出的图表或仪表板的 ID。
  • 图像格式:支持 PNG、JPEG 等多种格式,可根据需求选择。
  • 其他选项:可根据 Superset 文档配置导出大小、主题等参数。

五. 响应格式

  • 返回类型:API 会以二进制格式返回图像数据。
  • 使用方式:可以将二进制数据保存为文件,或直接嵌入到报告和应用程序中,实现可视化数据共享的自动化。

六. cURL 命令示例

以下示例展示了如何使用 cURL 导出图表图像:

curl -X POST http://superset.example.com/api/v1/chart/export/ \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
--data-raw '{"dashboard_id": YOUR_CHART_ID, "format": "png"}'

请将 YOUR_ACCESS_TOKENYOUR_CHART_ID 替换为实际的访问令牌和图表 ID。您还可以根据需要修改 "format" 参数来生成不同类型的图像。


七. 总结

通过 Superset API 的图像导出功能,您可以轻松将仪表板和图表生成可共享的图像格式,从而快速分发数据见解、生成报告或自动化数据流程。结合有效的身份验证和自定义参数,导出的图像可以直接应用于业务和分析场景。

原文链接: https://blog.elest.io/superset-download-as-image-api-guide/