File tree Expand file tree Collapse file tree 2 files changed +32
-11
lines changed
docs/reference/data-frames/apis Expand file tree Collapse file tree 2 files changed +32
-11
lines changed Original file line number Diff line number Diff line change @@ -36,13 +36,20 @@ Retrieves usage information for {dataframe-transforms}.
36
36
specify one of these options, the API returns information for all
37
37
{dataframe-transforms}.
38
38
39
+ `from`::
40
+ (integer) Skips the specified number of {dataframe-transforms}. The
41
+ default value is `0`.
42
+
43
+ `size`::
44
+ (integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
39
45
40
46
==== Results
41
47
42
48
The API returns the following information:
43
49
44
50
`transforms`::
45
- (array) An array of statistics objects for {dataframe-transforms}.
51
+ (array) An array of statistics objects for {dataframe-transforms}, which are
52
+ sorted by the `id` value in ascending order.
46
53
47
54
==== Authorization
48
55
@@ -54,6 +61,16 @@ see {stack-ov}/security-privileges.html[Security privileges] and
54
61
55
62
==== Examples
56
63
64
+ The following example skips for the first five {dataframe-transforms} and
65
+ gets usage information for a maximum of ten results:
66
+
67
+ [source,js]
68
+ --------------------------------------------------
69
+ GET _data_frame/transforms/_stats?from=5&size=10
70
+ --------------------------------------------------
71
+ // CONSOLE
72
+ // TEST[skip:todo]
73
+
57
74
The following example gets usage information for the `ecommerce_transform`
58
75
{dataframe-transform}:
59
76
Original file line number Diff line number Diff line change @@ -35,25 +35,20 @@ Retrieves configuration information for {dataframe-transforms}.
35
35
specify one of these options, the API returns information for all
36
36
{dataframe-transforms}.
37
37
38
- ////
39
- ==== Request Body
40
-
41
- `page`::
42
- `from`:::
38
+ `from`::
43
39
(integer) Skips the specified number of {dataframe-transforms}. The
44
40
default value is `0`.
45
41
46
- `size`:::
47
- (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
48
- The default value is `100`.
49
- ////
42
+ `size`::
43
+ (integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
50
44
51
45
==== Results
52
46
53
47
The API returns the following information:
54
48
55
49
`transforms`::
56
- (array) An array of transform resources.
50
+ (array) An array of transform resources, which are sorted by the `id` value in
51
+ ascending order.
57
52
58
53
==== Authorization
59
54
@@ -65,6 +60,15 @@ see {stack-ov}/security-privileges.html[Security privileges] and
65
60
66
61
==== Examples
67
62
63
+ The following example retrieves information about a maximum of ten transforms:
64
+
65
+ [source,js]
66
+ --------------------------------------------------
67
+ GET _data_frame/transforms?size=10
68
+ --------------------------------------------------
69
+ // CONSOLE
70
+ // TEST[skip:setup kibana sample data]
71
+
68
72
The following example gets configuration information for the
69
73
`ecommerce_transform` {dataframe-transform}:
70
74
You can’t perform that action at this time.
0 commit comments