Merge branch 'saved-objects-aggs' of github.com:XavierM/kibana into s…

…aved-objects-aggs
elastic · Nov 11, 2020 · 37ad64d · 37ad64d
2 parents 433a71c + 4f667d4
commit 37ad64d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts
@@ -109,6 +109,13 @@ export interface SavedObjectsFindOptions {
    */
   defaultSearchOperator?: 'AND' | 'OR';
   filter?: string | KueryNode;
+  /**
+   * Specify an Elasticsearch aggregation to perform. This alpha API only supports a limited set of aggregation types: metrics, bucket. Additional aggregation types can be contributed to Core.
+   * @alpha
+   * @example
+   * aggs = { type_count: { max: { field: 'dashboard.attributes.version' } } };
+   * SavedObjects.find({type: 'dashboard', aggs: '%7B%22type_count%22%3A%7B%22max%22%3A%7B%22field%22%3A%22dashboard.attributes.version%22%7D%7D%7D'})
+   */
   aggs?: SavedObjectsAggs;
   namespaces?: string[];
   /**