[[reference-cat-ml_data_frame_analytics]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.cat.mlDataFrameAnalytics

Get data frame analytics jobs. Returns configuration and usage information about data frame analytics jobs. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

{ref}/cat-dfanalytics.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(CatMlDataFrameAnalyticsRequest, options?): Promise<CatMlDataFrameAnalyticsResponse>
----

[discrete]
===== `CatMlDataFrameAnalyticsRequest`

[source,ts]
----
interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
  id?: <<shared-type-id, Id>>
  allow_no_match?: boolean
  bytes?: <<shared-type-bytes, Bytes>>
  h?: CatCatDfaColumns
  s?: CatCatDfaColumns
  time?: <<shared-type-duration, Duration>>
}
----

[discrete]
===== `CatMlDataFrameAnalyticsResponse`

[source,ts]
----
type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[]
----

