菜单
Grafana文档 开发人员 HTTP API 报告API
企业 开源

报告API

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

报告API尚未稳定,它仍在积极发展和可能变化不另行通知。

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

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

列出所有的报告

得到/ api /报告

需要的权限

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

行动 范围
报告:读 报告:*
报告:id: *

示例请求

HTTP / 1.1 / api /报告接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:1840 [{" id ": 2,“标识”:1、“orgId”: 1、“名称”:“报告2”,“收件人”:“example-report@www.tubolov.com”,“replyTo”:“”,“消息”:“嗨,\ nPlease找到附加一个PDF状态报告。如果你有任何问题,随时联系我!\ nb,”、“进度”:{“startDate可以”:“2022 - 10 - 02 - t00:00:00 + 02:00”、“endDate”:空,“频率”:“一次”,“intervalFrequency”:“”,“intervalAmount”: 0,“workdaysOnly”:假的,“dayOfMonth”:“2”,“时区”:“欧洲/华沙”},“选项”:{“取向”:“风景”,“布局”:“网格”,},“enableDashboardUrl”:真的,“国家”:“计划”、“仪表板”:[{“仪表板”:{" id ": 463年,“uid”:“7 meksybmk”、“名称”:“TestData报警”},“reportVariables”: {“namefilter”:“TestData}}],“格式”:“pdf”,“csv”,“创建”:“2022 - 09 - 19 - t11:44:42 + 02:00”、“更新”:“2022 - 09 - 19 t11:44:42 + 02:00 "})

状态码

  • 200年-好吧
  • 401年——身份验证失败,请参考身份验证API。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志。

得到一个报告

GET / api /报告/:id

需要的权限

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

行动 范围
报告:读 报告:*
报告:id: *
报告:id: 1(单报告)

示例请求

得到/ api /报告/ 2 HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:940 {" id ": 2,“标识”:1、“orgId”: 1、“名称”:“报告2”,“收件人”:“example-report@www.tubolov.com”,“replyTo”:“”,“消息”:“嗨,\ nPlease找到附加一个PDF状态报告。如果你有任何问题,随时联系我!\ nb,”、“进度”:{“startDate可以”:“2022 - 10 - 02 - t00:00:00 + 02:00”、“endDate”:空,“频率”:“一次”,“intervalFrequency”:“”,“intervalAmount”: 0,“workdaysOnly”:假的,“dayOfMonth”:“2”,“时区”:“欧洲/华沙”},“选项”:{“取向”:“风景”,“布局”:“网格”,},“enableDashboardUrl”:真的,“国家”:“计划”、“仪表板”:[{“仪表板”:{" id ": 463年,“uid”:“7 meksybmk”、“名称”:“TestData报警”},“timeRange”:{“从”:“,”到“:”},“reportVariables”: {“namefilter”:“TestData}}],“格式”:“pdf”,“csv”,“创建”:“2022 - 09 - 12 - t11:44:42 + 02:00”、“更新”:“2022 - 09 - 12 - t11:44:42 + 02:00 "}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的报告ID)。
  • 401年——身份验证失败,请参考身份验证API。
  • 403年禁止(拒绝访问的报告或报告)中使用的仪表板。
  • 404年——没有找到(报告不存在)。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志。

创建一个报告

POST / api /报告

需要的权限

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

行动 范围
报告:创建 n /一个

示例请求

POST HTTP / 1.1 / api /报告接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{“名称”:“报告4”、“接受者”:“texample-report@www.tubolov.com”,“replyTo”:“”,“消息”:“你好,请找到附加报告”,“计划”:{“startDate可以”:“2022 - 10 - 02 - t10:00:00 + 02:00”、“endDate”:“2022 - 11 - 02 - t20:00:00 + 02:00”、“频率”:“每天”,“intervalFrequency”:“”,“intervalAmount”: 0,“workdaysOnly”:真的,“时区”:“欧洲/华沙”},“选项”:{“取向”:“景观”、“布局”:“网格”},“enableDashboardUrl”:真的,“仪表板”:[{“仪表板”:{“uid”:“7 meksybmk”},“timeRange”:{“从”:“2022 - 08年- 08 - t15:00:00 + 02:00”,“对”:“2022 - 09 - 02 - t17:00:00 + 02:00”},“reportVariables”: {“varibale1”:“Value1}}],“格式”:[“pdf”,“csv”]}

配置JSON身体模式

字段名 数据类型 描述
的名字 字符串 报告的名称用作电子邮件主题。
收件人 字符串 以逗号分隔的邮件发送报告。
replyTo 字符串 以逗号分隔的电子邮件报告的应答字段中使用电子邮件。
消息 字符串 短信用于身体报告的电子邮件。
startDate可以 字符串 从这个日期报告分布。
endDate 字符串 报告分配结束日期。
频率 字符串 指定的频率应该发送报告。可以一次,每小时,每天,每周,每月,去年或自定义。

去年——进度报告的最后一天。

自定义——进度报告发送一个自定义的时间间隔。
它需要intervalFrequency和intervalAmount指定:例如,每2周,2是一个intervalAmount和周是一个intervalFrequency。
intervalFrequency 字符串 的类型自定义间隔:小时,天,周,个月。
intervalAmount 数量 自定义时间间隔。
workdaysOnly 字符串 只在Monday-Friday发送报告。适用于每小时和每天类型的时间表。
时区 字符串 时区用于进度报告执行。
取向 字符串 可以肖像或景观。
布局 字符串 可以网格或简单的。
enableDashboardUrl bool 添加一个仪表板url报告邮件的底部。
格式 []字符串 指定什么样的附件来生成报告csv,pdf,图像。
pdf是默认的。
csv高度为每个表一个CSV文件面板。
图像嵌入的图像仪表板到电子邮件的身体。
指示板 []对象 仪表板来生成一个报告。
请参阅下面的“报告仪表板模式”一节。

报告指示板模式

字段名 数据类型 描述
dashboard.uid 字符串 指示板UID。
timeRange.from 字符串 仪表板的时间范围。
timeRange.to 字符串 仪表板时间范围。
reportVariables。 字符串 键-值对包含这个报告的模板变量,以JSON格式。如果空,报告的模板变量将使用的仪表板。

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:35 {" id ": 4,“消息”:“报告创建”}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的json,缺失或无效的字段值,等等)。
  • 403年禁止(拒绝访问的报告或报告)中使用的仪表板。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志

更新的报告

/ api /报告/:id

需要的权限

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

行动 范围
报告:写 报告:*
报告:id: *
报告:1(单报告)

示例请求

看到JSON身体模式字段的描述。

得到HTTP / 1.1 / api /报告接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{“名称”:“更新报告”、“接受者”:“example-report@www.tubolov.com”,“replyTo”:“”,“消息”:“你好,请找到附加报告”,“计划”:{“频率”:“每小时”、“时区”:“非洲/开罗”、“workdaysOnly”:真的,“startDate可以”:“2022 - 10 - 10 - t10:00:00 + 02:00”、“endDate”:“2022 - 11 - 20 - t19:00:00 + 02:00”},“选项”:{“取向”:“风景”,“布局”:“网格”,},“enableDashboardUrl”:真的,“状态”:“计划”,“仪表板”:[{“仪表板”:{" id ": 463年,“uid”:“7 meksybmk”、“名称”:“TestData报警”},“timeRange”:{“从”:“2022 - 08年- 08 - t15:00:00 + 02:00”,“对”:“2022 - 09 - 02 - t17:00:00 + 02:00”},“reportVariables”: {“varibale1”:“Value1}}],“格式”:[“pdf”,“csv”]}

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:28{“消息”:“报告更新”}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的json,缺失或无效的字段值,等等)。
  • 401年——身份验证失败,请参考身份验证API。
  • 403年禁止(拒绝访问的报告或报告)中使用的仪表板。
  • 404年——没有找到(报告不存在)。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志。

删除一个报告

删除/ api /报告/:id

需要的权限

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

行动 范围
报告:删除 报告:*
报告:id: *
报告:1(单报告)

示例请求

得到/ api /报告/ 6 HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:39{“消息”:“报告配置被“}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的报告ID)。
  • 401年——身份验证失败,请参考身份验证API。
  • 404年——没有找到与这个ID不存在(报告)。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志

发送一个报告

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年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志。

得到报告品牌设置

GET / api /报告/设置

返回报告是全球性的品牌设置和使用的所有报告。

需要的权限

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

行动 范围
reports.settings:阅读 n /一个

示例请求

GET / api /报告/设置HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:181 {" id ": 1、“标识”:1、“orgId”: 1,“品牌”:{“reportLogoUrl”:“”,“emailLogoUrl”:“”,“emailFooterMode”:“发送”、“emailFooterText”:“Grafana实验室”、“emailFooterLink”: " https://bob电竞频道www.tubolov.com/ "}}

状态码

  • 200年-好吧
  • 401年——身份验证失败,请参考身份验证API。
  • 500年——意想不到的错误或服务器错误配置。更详细请参考服务器日志

保存报告品牌设置

POST / api /报告/设置

创建设置,如果他们不存在,否则更新他们。这些设置是全球性的,用在所有的报告。

需要的权限

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

行动 范围
reports.settings:写 n /一个

示例请求

POST / api /报告/设置HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{"品牌":{“reportLogoUrl”:“//www.tubolov.com/reportLogo.jpg”,“emailLogoUrl”:“//www.tubolov.com/emailLogo.jpg”,“emailFooterMode”:“发送”、“emailFooterText”:“Grafana实验室”、“emailFooterLink”: " //www.tubolov.com/ "bob电竞频道}}

JSON身体模式

字段名 数据类型 描述
branding.reportLogoUrl 字符串 图像的URL用作标志每一页的报告。
branding.emailLogoUrl 字符串 图像的URL作为标志的邮件。
branding.emailFooterMode 字符串 可以发送的或没有一个。
发送的添加一个”派来的branding.emailFooterText“页脚的链接的电子邮件。需要指定值branding.emailFooterText和branding.emailFooterLink字段。
没有一个抑制添加一个“被”页脚的链接的电子邮件。
branding.emailFooterText 字符串 文本的一个URL添加到电子邮件”发送的“页脚。
branding.emailFooterLink 字符串 URL地址值添加到电子邮件”发送的“页脚。

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:35{“消息”:“报告设置保存”}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的json,缺失或无效的字段值,等等)。
  • 401年——身份验证失败,请参考身份验证API。
  • 500年——意想不到的错误或服务器错误配置。更详细请参考服务器日志

发送一个测试邮件

POST / api /报告/测试电子邮件

发送测试电子邮件报告没有持久化到数据库中。

需要的权限

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

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

示例请求

看到JSON身体模式字段的描述。

POST / api /报告/测试电子邮件HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{{“名称”:“报告4”、“接受者”:“example-report@www.tubolov.com”,“replyTo”:“”,“消息”:“你好,请找到附加报告”,“计划”:{“startDate可以”:“2022 - 10 - 02 - t10:00:00 + 02:00”、“endDate”:“2022 - 11 - 02 - t20:00:00 + 02:00”、“频率”:“每天”,“intervalFrequency”:“”,“intervalAmount”: 0,“workdaysOnly”:真的,“时区”:“欧洲/华沙”},“选项”:{“取向”:“景观”、“布局”:“网格”},“enableDashboardUrl”:真的,“仪表板”:[{“仪表板”:{“uid”:“7 meksybmk”},“timeRange”:{“从”:“2022 - 08年- 08 - t15:00:00 + 02:00”,“对”:“2022 - 09 - 02 - t17:00:00 + 02:00”},“reportVariables”: {“varibale1”:“Value1}}],“格式”:[“pdf”,“csv”]}

示例响应

HTTP / 1.1 200 OK - type: application / json内容长度:29日{“消息”:“测试电子邮件发送”}

状态码

  • 200年-好吧
  • 400年坏的请求(无效的json,缺失或无效的字段值,等等)。
  • 401年——身份验证失败,请参考身份验证API。
  • 403年禁止(拒绝访问的报告或报告)中使用的仪表板。
  • 500年——意想不到的错误或服务器错误配置。更多细节请参考服务器日志