重要:这个文档是关于一个旧版本。有关只释放指出,许多特性和功能的更新或替换。请查看当前版本。

报告API

这个API允许您以编程方式与互动报告特性。

报告是仅可在Grafana企业。阅读更多关于Grafana企业。

如果您正在运行Grafana企业,对于一些端点需要有特定的权限。指基于角色的访问控制权限为更多的信息。

发送一个报告

只有在企业Grafana v7.0 +。

这个API端点是实验性的,可能在将来的版本中被弃用。弃用,将提供迁移策略和端点将保持功能直到Grafana的下一个主要版本。

POST / api /报告/电子邮件

生成并发送报告。这个API等待返回之前生成的报告。我们建议您将客户的超时设置为至少60秒。

需要的权限

看到请注意介绍给一个解释。

行动	范围
报告:发送	n /一个

示例请求

POST HTTP / 1.1 / api /报告/电子邮件接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk {" id ":“3”,“useEmailsFromReport”:真正的}

JSON身体模式

字段名	数据类型	描述
id	字符串	ID报告的发送。它是一样的URL中编辑报告时,不要与仪表板的ID相混淆。必需的。
电子邮件	字符串	以逗号分隔的邮件发送报告。覆盖的电子邮件报告。如果需要useEmailsFromReport不存在。
useEmailsFromReport	布尔	发送报告中指定的电子邮件报告。如果需要电子邮件不存在。

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:29日{“消息”:“报告发送”}

状态码

代码	描述
200年	发送报告。
400年	坏的请求(无效的json,丢失的内容类型,缺失或无效的字段,等等)。
401年	身份验证失败,请参考身份验证API。
403年	用户身份验证,但未被授权来生成报告。
404年	报告没有找到。
500年	意想不到的错误或服务器错误配置。更多细节请参考服务器日志。