opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 01:02:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: update annotations docs to include typeahead support for tags (#36718)

Browse Source 
* Docs: update annotations docs to include typeahead support for tags

* Docs: Update Http API annotations including new endpoint to query by tags


Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
This commit is contained in:
Maria Alexandra
2021-07-21 10:23:15 +02:00
committed by GitHub
parent dbe7d3298d
commit 3fb80ac474
2 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/sources/http_api/annotations.md
View File

@ -251,3 +251,41 @@ Content-Type: application/json
"message":"Annotation deleted"
}
```
## Find Annotations Tags
`GET /api/annotations/tags`
Find all the event tags created in the annotations.
**Example Request**:
```http
GET /api/annotations/tags?tag=out HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
```
Query Parameters:
- `tag`: Optional. A string that you can use to filter tags.
- `limit`: Optional. A number, where the default is 100. Max limit for results returned.
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{
"result": {
"tags": [
{
"tag": "outage",
"count": 1
}
]
}
}
```