mirror of https://github.com/grafana/grafana.git synced 2024-11-26 02:40:26 -06:00

Docs: updates for file-based menu (#28500 )

* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

2020-11-09 12:26:49 -08:00

2.3 KiB

Raw Blame History

+++ title = "Reporting API" description = "Grafana Enterprise APIs" keywords = ["grafana", "enterprise", "api", "reporting"] aliases = ["/docs/grafana/latest/http_api/reporting/"] +++

Reporting API

This API allows you to interact programmatically with the [Reporting]({{< relref "../enterprise/reporting.md" >}}) feature.

Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).

Send a report

Only available in Grafana Enterprise v7.0+.

This API endpoint is experimental and may be deprecated in a future release. On deprecation, a migration strategy will be provided and the endpoint will remain functional until the next major release of Grafana.

POST /api/reports/email

Generate and send a report. This API waits for the report to be generated before returning. We recommend that you set the client's timeout to at least 60 seconds.

Example request

POST /api/reports/email HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "id":"3",
  "useEmailsFromReport": true
}

JSON Body Schema

Field name	Data type	Description
id	string	ID of the report to send. It is the same as in the URL when editing a report, not to be confused with the ID of the dashboard. Required.
emails	string	Comma-separated list of emails to which to send the report to. Overrides the emails from the report. Required if useEmailsFromReport is not present.
useEmailsFromReport	boolean	Send the report to the emails specified in the report. Required if emails is not present.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 29

{"message":"Report was sent"}

Status Codes

Code	Description
200	Report was sent.
400	Bad request (invalid json, missing content-type, missing or invalid fields, etc.).
401	Authentication failed, refer to [Authentication API]({{< relref "../http_api/auth.md" >}}).
403	User is authenticated but is not authorized to generate the report.
404	Report not found.
500	Unexpected error or server misconfiguration. Refer to body and/or server logs for more details.

2.3 KiB Raw Blame History