summaryrefslogtreecommitdiffstats
path: root/web/api/formatters/value/README.md
blob: 5024e74ee6a128a5572fd0adf0d712a1830a02bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Value formatter

The Value formatter presents [results of database queries](../../queries) as a single value.

To calculate the single value to be returned, it sums the values of all dimensions.

The Value formatter respects the following API `&options=`:

option|supported|description
:---:|:---:|:---
`percent`|yes|to replace all values with their percentage over the row total
`abs`|yes|to turn all values positive, before using them
`min2max`|yes|to return the delta from the minimum value to the maximum value (across dimensions)

The Value formatter is not exposed by the API by itself.
Instead it is used by the [`ssv`](../ssv) formatter
and [health monitoring queries](../../../../health).