summaryrefslogtreecommitdiffstats
path: root/web/api/formatters/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2019-09-03 10:23:38 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2019-09-03 10:23:38 +0000
commit574098461cd45be12a497afbdac6f93c58978387 (patch)
tree9eb60a5930b7c20d42f7fde1e234cae3968ed3d9 /web/api/formatters/README.md
parentAdding upstream version 1.16.1. (diff)
downloadnetdata-574098461cd45be12a497afbdac6f93c58978387.tar.xz
netdata-574098461cd45be12a497afbdac6f93c58978387.zip
Adding upstream version 1.17.0.upstream/1.17.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/api/formatters/README.md')
-rw-r--r--web/api/formatters/README.md35
1 files changed, 17 insertions, 18 deletions
diff --git a/web/api/formatters/README.md b/web/api/formatters/README.md
index b4ce1e30d..037fb5346 100644
--- a/web/api/formatters/README.md
+++ b/web/api/formatters/README.md
@@ -5,20 +5,20 @@ Using API parameters, the caller may define the format he/she wishes to get back
The following formats are supported:
-format|module|content type|description
-:---:|:---:|:---:|:-----
-`array`|[ssv](ssv)|application/json|a JSON array
-`csv`|[csv](csv)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines
-`csvjsonarray`|[csv](csv)|application/json|a JSON array, with each row as another array (the first row has the dimension names)
-`datasource`|[json](json)|application/json|a Google Visualization Provider `datasource` javascript callback
-`datatable`|[json](json)|application/json|a Google `datatable`
-`html`|[csv](csv)|text/html|an html table
-`json`|[json](json)|application/json|a JSON object
-`jsonp`|[json](json)|application/json|a JSONP javascript callback
-`markdown`|[csv](csv)|text/plain|a markdown table
-`ssv`|[ssv](ssv)|text/plain|a space separated list of values
-`ssvcomma`|[ssv](ssv)|text/plain|a comma separated list of values
-`tsv`|[csv](csv)|text/plain|a TAB delimited `csv` (MS Excel flavor)
+| format|module|content type|description|
+|:----:|:----:|:----------:|:----------|
+| `array`|[ssv](ssv)|application/json|a JSON array|
+| `csv`|[csv](csv)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines|
+| `csvjsonarray`|[csv](csv)|application/json|a JSON array, with each row as another array (the first row has the dimension names)|
+| `datasource`|[json](json)|application/json|a Google Visualization Provider `datasource` javascript callback|
+| `datatable`|[json](json)|application/json|a Google `datatable`|
+| `html`|[csv](csv)|text/html|an html table|
+| `json`|[json](json)|application/json|a JSON object|
+| `jsonp`|[json](json)|application/json|a JSONP javascript callback|
+| `markdown`|[csv](csv)|text/plain|a markdown table|
+| `ssv`|[ssv](ssv)|text/plain|a space separated list of values|
+| `ssvcomma`|[ssv](ssv)|text/plain|a comma separated list of values|
+| `tsv`|[csv](csv)|text/plain|a TAB delimited `csv` (MS Excel flavor)|
For examples of each format, check the relative module documentation.
@@ -59,16 +59,15 @@ This is such an object:
## Downloading data query result files
Following the [Google Visualization Provider guidelines](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source),
-netdata supports parsing `tqx` options.
+Netdata supports parsing `tqx` options.
-Using these options, any netdata data query can instruct the web browser to download
+Using these options, any Netdata data query can instruct the web browser to download
the result and save it under a given filename.
For example, to download a CSV file with CPU utilization of the last hour,
[click here](https://registry.my-netdata.io/api/v1/data?chart=system.cpu&after=-3600&format=csv&options=nonzero&tqx=outFileName:system+cpu+utilization+of+the+last_hour.csv).
-
This is done by appending `&tqx=outFileName:FILENAME` to any data query.
The output will be in the format given with `&format=`.
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fweb%2Fapi%2Fformatters%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fweb%2Fapi%2Fformatters%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)