IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
4e37a53a1c
grafana/docs/sources/http_api/query_history.md
Ivana Huckova 4e37a53a1c
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
2022-01-28 17:55:09 +01:00

1.3 KiB
Raw Blame History

+++ 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:

POST /api/query-history HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
  "dataSourceUid": "PE1C5CBDA0504A6A3",
  "queries": [
    {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
    }
]
}

JSON body schema:

  • datasourceUid – Data source uid.
  • queries – JSON of query or queries.

Example response:

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)