# Elastic ml data frame API

**Canonical:** https://apis.io/apis/elastic/elastic-ml-data-frame-api/  
**Provider:** Elastic — https://apis.io/providers/elastic/  
**Base URL:** https://api.elastic-cloud.com  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch

Elastic ml data frame API is one of 50 APIs that [Elastic](https://apis.io/providers/elastic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include ml data frame. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

The machine learning data frame analytics APIs enable you to perform data frame analytics activities.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/_ml/data_frame/analytics/{id}` | Get data frame analytics job configuration info |
| PUT | `/_ml/data_frame/analytics/{id}` | Create a data frame analytics job |
| DELETE | `/_ml/data_frame/analytics/{id}` | Delete a data frame analytics job |
| POST | `/_ml/data_frame/_evaluate` | Evaluate data frame analytics |
| GET | `/_ml/data_frame/analytics/_explain` | Explain data frame analytics config |
| POST | `/_ml/data_frame/analytics/_explain` | Explain data frame analytics config |
| GET | `/_ml/data_frame/analytics/{id}/_explain` | Explain data frame analytics config |
| POST | `/_ml/data_frame/analytics/{id}/_explain` | Explain data frame analytics config |
| GET | `/_ml/data_frame/analytics` | Get data frame analytics job configuration info |
| GET | `/_ml/data_frame/analytics/_stats` | Get data frame analytics job stats |
| GET | `/_ml/data_frame/analytics/{id}/_stats` | Get data frame analytics job stats |
| GET | `/_ml/data_frame/analytics/_preview` | Preview features used by data frame analytics |
| POST | `/_ml/data_frame/analytics/_preview` | Preview features used by data frame analytics |
| GET | `/_ml/data_frame/analytics/{id}/_preview` | Preview features used by data frame analytics |
| POST | `/_ml/data_frame/analytics/{id}/_preview` | Preview features used by data frame analytics |
| POST | `/_ml/data_frame/analytics/{id}/_start` | Start a data frame analytics job |
| POST | `/_ml/data_frame/analytics/{id}/_stop` | Stop data frame analytics jobs |
| POST | `/_ml/data_frame/analytics/{id}/_update` | Update a data frame analytics job |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-ml-data-frame-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/api/doc/elasticsearch
- **Documentation** — https://www.elastic.co/docs/api/doc/kibana
- **Documentation** — https://www.elastic.co/docs/api/doc/cloud
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

## Other Elastic APIs (12)

- [Elastic Account API](https://apis.io/apis/elastic/elastic-account-api/)
- [Elastic Cluster API](https://apis.io/apis/elastic/elastic-cluster-api/)
- [Elastic Deployments API](https://apis.io/apis/elastic/elastic-deployments-api/)
- [Elastic Documents API](https://apis.io/apis/elastic/elastic-documents-api/)
- [Elastic Indices API](https://apis.io/apis/elastic/elastic-indices-api/)
- [Elastic Search API](https://apis.io/apis/elastic/elastic-search-api/)
- [Elastic Security API](https://apis.io/apis/elastic/elastic-security-api/)
- [Elastic Spaces API](https://apis.io/apis/elastic/elastic-spaces-api/)
- [Elastic Status API](https://apis.io/apis/elastic/elastic-status-api/)
- [Elastic TrafficFilters API](https://apis.io/apis/elastic/elastic-trafficfilters-api/)
- [Elastic Analytics API](https://apis.io/apis/elastic/elastic-analytics-api/)
- [Elastic Cat API](https://apis.io/apis/elastic/elastic-cat-api/)

## Tags

ml data frame

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic/elastic-ml-data-frame-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic/.