File tree Expand file tree Collapse file tree 3 files changed +29
-1
lines changed Expand file tree Collapse file tree 3 files changed +29
-1
lines changed Original file line number Diff line number Diff line change
1
+ [role="xpack"]
2
+ [testenv="basic"]
3
+ [[data-frame-transform-pivot]]
4
+ === Pivot resources
5
+
6
+ A pivot configuration object has the following properties:
7
+
8
+ `group_by` (required):: (object) Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are supported:
9
+ * {ref}/search-aggregations-bucket-composite-aggregation.html#_terms[Terms]
10
+ * {ref}/search-aggregations-bucket-composite-aggregation.html#_histogram[Histogram]
11
+ * {ref}/search-aggregations-bucket-composite-aggregation.html#_date_histogram[Date Histogram]
12
+
13
+ `aggregations` (required):: (object) Defines how to aggregate the grouped data.
14
+ The following aggregations are supported:
15
+ * {ref}/search-aggregations-metrics-avg-aggregation.html[Average]
16
+ * {ref}/search-aggregations-metrics-weight-avg-aggregation.html[Weighted Average]
17
+ * {ref}/search-aggregations-metrics-cardinality-aggregation.html[Cardinality]
18
+ * {ref}/search-aggregations-metrics-geocentroid-aggregation.html[Geo Centroid]
19
+ * {ref}/search-aggregations-metrics-max-aggregation.html[Max]
20
+ * {ref}/search-aggregations-metrics-min-aggregation.html[Min]
21
+ * {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted Metric]
22
+ * {ref}/search-aggregations-metrics-sum-aggregation.html[Sum]
23
+ * {ref}/search-aggregations-metrics-valuecount-aggregation.html[Value Count]
24
+ * {ref}/search-aggregations-metrics-bucket_script-aggregation.html[Bucket Script]
25
+
26
+ //For more information, see {stack-ov}/ml-dataframes.html[dataframes-cap}].
Original file line number Diff line number Diff line change @@ -39,7 +39,7 @@ a `query`.
39
39
`dest` (required):: (object) The destination configuration, consisting of `index`.
40
40
41
41
`pivot`:: (object) Defines the pivot function `group by` fields and the aggregation to
42
- reduce the data.
42
+ reduce the data. See <<data-frame-transform-pivot, data frame transform pivot objects>>.
43
43
44
44
`description`:: Optional free text description of the data frame transform
45
45
Original file line number Diff line number Diff line change @@ -12,6 +12,7 @@ These resource definitions are used in APIs related to {ml-features} and
12
12
* <<ml-job-resource,Jobs>>
13
13
* <<ml-jobstats,Job statistics>>
14
14
* <<ml-snapshot-resource,Model snapshots>>
15
+ * <<data-frame-transform-pivot,Pivots>>
15
16
* <<ml-results-resource,Results>>
16
17
* <<role-mapping-resources,Role mappings>>
17
18
* <<ml-event-resource,Scheduled Events>>
@@ -22,6 +23,7 @@ include::{es-repo-dir}/ml/apis/filterresource.asciidoc[]
22
23
include::{es-repo-dir}/ml/apis/jobresource.asciidoc[]
23
24
include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[]
24
25
include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[]
26
+ include::{es-repo-dir}/data-frames/apis/pivotresource.asciidoc[]
25
27
include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[]
26
28
include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[]
27
29
include::{es-repo-dir}/ml/apis/eventresource.asciidoc[]
You can’t perform that action at this time.
0 commit comments