Skip to content

Commit 8dee58f

Browse files
author
Rosario Trischitta
committed
docs: add parameter description for aggregation endpoints
1 parent 4579471 commit 8dee58f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/response-parameters.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ When requested, the result will contain OSM elements' tags as individual GeoJSON
2121
Aggregation Parameters
2222
----------------------
2323

24+
**specific for all groupBy endpoints**
25+
26+
* ``groupByResult`` - GroupBy result object containing the groupBy value and the respective objects. In the /ratio/groupBy/boundary endpoint, this parameter is replaced by ``groupByBoundaryResult``
27+
* ``groupByObject`` - Object on which the results are grouped on
28+
29+
**specific for all ratio endpoints**
30+
31+
* ``ratioResult`` - Result JSON object containing the timestamp together with two values and their resulting ratio.
32+
33+
**specific for the /ratio/groupBy/boundary endpoint**
34+
35+
* ``groupByBoundaryResult`` - Result grouped by boundary containing groupByObject and ratioResult objects
36+
2437
Extraction Parameters
2538
---------------------
2639

0 commit comments

Comments
 (0)