Query history: Create API to add query to query history (#44479)

* Create config to enable/disable query history

* Create add to query history functionality

* Add documentation

* Add test

* Refactor

* Add test

* Fix built errors and linting errors

* Refactor

* Remove old tests

* Refactor, adjust based on feedback, add new test

* Update default value
This commit is contained in:
Ivana Huckova
2022-01-28 17:55:09 +01:00
committed by GitHub
parent ca24b95b49
commit 4e37a53a1c
15 changed files with 339 additions and 2 deletions

View File

@ -0,0 +1,59 @@
+++
title = "Query History HTTP API "
description = "Grafana Query History HTTP API"
keywords = ["grafana", "http", "documentation", "api", "queryHistory"]
aliases = ["/docs/grafana/latest/http_api/query_history/"]
+++
# Query history API
This API can be used to add queries to Query history. It requires that the user is logged in and that Query history feature is enabled in config file.
## Add query to Query history
`POST /api/query-history`
Adds query to query history.
**Example request:**
```http
POST /api/query-history HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
```
JSON body schema:
- **datasourceUid** Data source uid.
- **queries** JSON of query or queries.
**Example response:**
```http
HTTP/1.1 200
Content-Type: application/json
{
```
Status codes:
- **200** OK
- **500** Errors (invalid JSON, missing or invalid fields)
**Example response:**
```http
HTTP/1.1 200
Content-Type: application/json
{
"message": "Query successfully added to query history",
}
```
Status codes:
- **200** OK
- **500** Errors (invalid JSON, missing or invalid fields)