Skip to content

Commit e39cdd6

Browse files
authored
[DOCS] Adds progress parameter description to the GET stats data frame analytics API doc. (#46434)
1 parent 89857dd commit e39cdd6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,15 @@ experimental[]
2424

2525
`GET _ml/data_frame/analytics/*/_stats`
2626

27+
2728
[[ml-get-dfanalytics-stats-prereq]]
2829
==== {api-prereq-title}
2930

3031
* You must have `monitor_ml` privilege to use this API. For more
3132
information, see {stack-ov}/security-privileges.html[Security privileges] and
3233
{stack-ov}/built-in-roles.html[Built-in roles].
3334

35+
3436
[[ml-get-dfanalytics-stats-path-params]]
3537
==== {api-path-parms-title}
3638

@@ -39,6 +41,7 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
3941
one of these options, the API returns information for the first hundred
4042
{dfanalytics-jobs}.
4143

44+
4245
[[ml-get-dfanalytics-stats-query-params]]
4346
==== {api-query-parms-title}
4447

@@ -64,6 +67,7 @@ when there are no matches or only partial matches.
6467
(Optional, integer) Specifies the maximum number of {dfanalytics-jobs} to
6568
obtain. The default value is `100`.
6669

70+
6771
[[ml-get-dfanalytics-stats-response-body]]
6872
==== {api-response-body-title}
6973

@@ -72,6 +76,24 @@ The API returns the following information:
7276
`data_frame_analytics`::
7377
(array) An array of statistics objects for {dfanalytics-jobs}, which are
7478
sorted by the `id` value in ascending order.
79+
80+
`id`::
81+
(string) The unique identifier of the {dfanalytics-job}.
82+
83+
`state`::
84+
(string) Current state of the {dfanalytics-job}.
85+
86+
`progress`::
87+
(array) The progress report of the {dfanalytics-job} by phase.
88+
89+
`phase`::
90+
(string) Defines the phase of the {dfanalytics-job}. Possible phases:
91+
`reindexing`, `loading_data`, `analyzing`, and `writing_results`.
92+
93+
`progress_percent`::
94+
(integer) The progress that the {dfanalytics-job} has made expressed in
95+
percentage.
96+
7597

7698
[[ml-get-dfanalytics-stats-response-codes]]
7799
==== {api-response-codes-title}
@@ -80,6 +102,7 @@ The API returns the following information:
80102
If `allow_no_match` is `false`, this code indicates that there are no
81103
resources that match the request or only partial matches for the request.
82104

105+
83106
[[ml-get-dfanalytics-stats-example]]
84107
==== {api-examples-title}
85108

@@ -90,6 +113,7 @@ GET _ml/data_frame/analytics/loganalytics/_stats
90113
// CONSOLE
91114
// TEST[skip:TBD]
92115

116+
93117
The API returns the following results:
94118

95119
[source,console-result]

0 commit comments

Comments
 (0)