OpenSearch/docs/reference/aggregations
Tanguy Leroux 3553522328 Add parameter to prefix aggs name with type in search responses (#22965)
This pull request adds a new parameter to the REST Search API named `typed_keys`. When set to true, the aggregation names in the search response will be prefixed with a prefix that reflects the internal type of the aggregation.

Here is a simple example:
```
GET /_search?typed_keys
{
    "aggs": {
        "tweets_per_user": {
            "terms": {
                "field": "user"
            }
        }
    },
    "size": 0
}
```

And the response:

```
{
    "aggs": {
        "sterms:tweets_per_user": {
            ...
        }
    }
}
```

This parameter is intended to make life easier for REST clients that could parse back the prefix and could detect the type of the aggregation to parse. It could also be implemented for suggesters.
2017-02-09 11:19:04 +01:00
..
bucket Docs: CONSOLEify histogram aggregation docs 2017-02-07 16:09:32 -05:00
matrix refactor matrix agg documentation from modules to main agg section 2016-06-06 07:39:00 -05:00
metrics Docs: CONSOLEify sum aggregation docs 2017-02-07 14:18:54 -05:00
pipeline Update bucket-script-aggregation.asciidoc (#22219) 2016-12-16 12:39:22 +01:00
bucket.asciidoc Docs fix - Added missing link to new Adjacency-matrix agg 2017-01-23 10:18:30 +00:00
matrix.asciidoc refactor matrix agg documentation from modules to main agg section 2016-06-06 07:39:00 -05:00
metrics.asciidoc Adds geo_centroid metric aggregator 2015-10-14 16:19:09 -05:00
misc.asciidoc Add parameter to prefix aggs name with type in search responses (#22965) 2017-02-09 11:19:04 +01:00
pipeline.asciidoc Remove most of the need for `// NOTCONSOLE` 2016-09-06 10:32:54 -04:00