Skip to content

Commit

Permalink
fix: aggregated_geometries param can only be applied for geohash/geot…
Browse files Browse the repository at this point in the history 
…ile aggregations
  • Loading branch information
@MohamedHamouGisaia
MohamedHamouGisaia committed Feb 27, 2025
1 parent c0fc153 commit dc3dd1f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/arlas-api-exploration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,25 @@ The other parts must be specified or not depending on the aggregation type. All

| Parameter | Aggregation type | Description |
| --------- | ------------- | ------------------------------------------------ |
| **interval** | `datehistogram, histogram, geohash, geotile` | mandatory |
| **interval** | `datehistogram, histogram, geohash, geotile` | mandatory |
| **format** | `datehistogram` | optional (default value : `yyyy-MM-dd-HH:mm:ss`) |
| (**collect_field**,**collect_fct**) | All types | optional and multiple |
| (**order**,**on**) | `term, histogram, datehistogram` | optional |
| **size** | `term, geohash, geotile` | optional |
| **size** | `term, geohash, geotile` | optional |
| **include** | `term` | optional |
| **aggregated_geometries** | All types | optional |
| **aggregated_geometries** | `geohash, geotile` | optional |
| **raw_geometries** | All types | optional |
| **fetch_hits** | All types | optional |

> Example: `agg=datehistogram:date:interval-20day:format-dd.MM.yyyy`&`agg=term:sexe:collect_field-age:collect_fct-avg:order-asc:on-result:size-5`
The sub-parameters possible values are:

| Parameter | Values | Description |
| ----------------- | ---------------------------------------------- | ---------------------------------------- |
| **{type}** | `datehistogram`, `histogram`, `geohash`, `geotile`, `term` | Type of aggregation |
| **{field}** | {field} | Aggregates on {field} |
| **interval** | {interval} | Size of the intervals.(1) |
| Parameter | Values | Description |
| ----------------- | --------------------------------------------------------- | ---------------------------------------- |
| **{type}** | `datehistogram`, `histogram`, `geohash`, `geotile`, `term` | Type of aggregation |
| **{field}** | {field} | Aggregates on {field} |
| **interval** | {interval} | Size of the intervals.(1) |
| **format** | [Date format](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern) for key aggregation | Date format for key aggregation. |
| **collect_field** | `{collect_field}` | The field used to aggregate collections. |
| **collect_fct** | `avg,cardinality,max,min,sum,geobbox,geocentroid (2)` | The aggregation function to apply to collections on the specified **collect_field**. |
Expand Down

0 comments on commit dc3dd1f

Please sign in to comment.