Docs: Moves http api docs to the developer docs (#49255)

* updates relrefs after move Co-authored-by: Chris Moyer <chris.moyer@grafana.com> * applies weights Co-authored-by: Chris Moyer <chris.moyer@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * updates developer _index page * make prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-20 12:46:27 -05:00
parent 3d5d8c785b
commit ee9ea64834
88 changed files with 191 additions and 185 deletions
@@ -0,0 +1,76 @@
+++
+aliases = ["/docs/grafana/latest/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.md" >}}) feature.
+
+> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}).
+
+> If you have [Role-based access control]({{< relref "../../enterprise/access-control/_index.md" >}}) enabled, for some endpoints you would need to have relevant permissions.
+> Refer to specific resources to understand what permissions are required.
+
+## 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.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 server logs for more details. |