Jack Baldry
cee5c1ca02
* Use relative aliases for all non-current Grafana aliases Prevents non-latest documentation "stealing" the page away from latest and through permanent redirects for latest pages that no longer exist. The redirected pages are indexed by search engines but our robots.txt forbids them crawling the non-latest page. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove all current page aliases find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/latest/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \; Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
81 lines
3.4 KiB
Markdown
81 lines
3.4 KiB
Markdown
---
|
|
aliases:
|
|
- ../../http_api/reporting/
|
|
description: Grafana Enterprise APIs
|
|
keywords:
|
|
- grafana
|
|
- enterprise
|
|
- api
|
|
- reporting
|
|
title: Reporting API
|
|
---
|
|
|
|
# Reporting API
|
|
|
|
This API allows you to interact programmatically with the [Reporting]({{< relref "../../enterprise/reporting/" >}}) feature.
|
|
|
|
> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}).
|
|
|
|
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information.
|
|
|
|
## 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.
|
|
|
|
#### Required permissions
|
|
|
|
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ------------ | ----- |
|
|
| reports:send | n/a |
|
|
|
|
### Example request
|
|
|
|
```http
|
|
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
|
|
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 "auth/" >}}). |
|
|
| 403 | User is authenticated but is not authorized to generate the report. |
|
|
| 404 | Report not found. |
|
|
| 500 | Unexpected error or server misconfiguration. Refer to server logs for more details. |
|