summaryrefslogtreecommitdiffstats
path: root/web
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2023-04-12 07:11:11 -0700
committerGitHub <noreply@github.com>2023-04-12 07:11:11 -0700
commit6b7c88875781e086d0221c55a5a60255ee593ecd (patch)
treeae07111b9461a9d1fb3467dd8c2d19564ec7b8bf /web
parentfdcddcd06ef8babb48ccf1a5d12545bcd7926396 (diff)
Update README.md (#14898)
Clarify that these queries work for the `lookup` line in alerts as well.
Diffstat (limited to 'web')
-rw-r--r--web/api/queries/README.md14
1 files changed, 5 insertions, 9 deletions
diff --git a/web/api/queries/README.md b/web/api/queries/README.md
index 033115ded6..b21133db55 100644
--- a/web/api/queries/README.md
+++ b/web/api/queries/README.md
@@ -1,14 +1,10 @@
-<!--
-title: "REST API for Database Queries"
-sidebar_label: "REST API for Database Queries"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
-learn_status: "Published"
-learn_rel_path: "Integrations/Export"
--->
+# Database queries/lookup
-# REST API for Database Queries
+This document explains in detail the options available to retrieve data from the Netdata timeseries database in order to configure alerts, create badges or
+create custom charts.
-The Netdata database can be queried with the `/api/v1/data` and `/api/v1/badge.svg` REST API methods.
+The Netdata database can be queried with the `/api/v1/data` and `/api/v1/badge.svg` REST API methods. The database is also queried from the `lookup` line
+in an [alert configuration](https://github.com/netdata/netdata/edit/master/health/REFERENCE.md).
Every data query accepts the following parameters: