master
md 19 lines 831 Bytes
Rendered Raw
1 # Value formatter
2
3 The Value formatter presents [results of database queries](/src/web/api/queries/README.md) as a single value.
4
5 To calculate the single value to be returned, it sums the values of all dimensions.
6
7 The Value formatter respects the following API `&options=`:
8
9 | option | supported | description |
10 |:----: |:-------: |:---------- |
11 | `percent` | yes | to replace all values with their percentage over the row total|
12 | `abs` | yes | to turn all values positive, before using them |
13 | `min2max` | yes | to return the delta from the minimum value to the maximum value (across dimensions)|
14
15 The Value formatter is not exposed by the API by itself.
16 Instead it is used by the [`ssv`](/src/web/api/formatters/ssv/README.md) formatter
17 and [health monitoring queries](/src/health/README.md).
18
19