diff options
Diffstat (limited to 'web/api/formatters/README.md')
| -rw-r--r-- | web/api/formatters/README.md | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/web/api/formatters/README.md b/web/api/formatters/README.md index 037fb5346..1fd2b3029 100644 --- a/web/api/formatters/README.md +++ b/web/api/formatters/README.md @@ -1,3 +1,8 @@ +<!-- +title: "Query formatting" +custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md +--> + # Query formatting API data queries need to be formatted before returned to the caller. @@ -7,18 +12,18 @@ 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)| +| `array`|[ssv](/web/api/formatters/ssv/README.md)|application/json|a JSON array| +| `csv`|[csv](/web/api/formatters/csv/README.md)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines| +| `csvjsonarray`|[csv](/web/api/formatters/csv/README.md)|application/json|a JSON array, with each row as another array (the first row has the dimension names)| +| `datasource`|[json](/web/api/formatters/json/README.md)|application/json|a Google Visualization Provider `datasource` javascript callback| +| `datatable`|[json](/web/api/formatters/json/README.md)|application/json|a Google `datatable`| +| `html`|[csv](/web/api/formatters/csv/README.md)|text/html|an html table| +| `json`|[json](/web/api/formatters/json/README.md)|application/json|a JSON object| +| `jsonp`|[json](/web/api/formatters/json/README.md)|application/json|a JSONP javascript callback| +| `markdown`|[csv](/web/api/formatters/csv/README.md)|text/plain|a markdown table| +| `ssv`|[ssv](/web/api/formatters/ssv/README.md)|text/plain|a space separated list of values| +| `ssvcomma`|[ssv](/web/api/formatters/ssv/README.md)|text/plain|a comma separated list of values| +| `tsv`|[csv](/web/api/formatters/csv/README.md)|text/plain|a TAB delimited `csv` (MS Excel flavor)| For examples of each format, check the relative module documentation. |