Get transforms APIedit

Retrieves configuration information for transforms.

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.


GET _data_frame/transforms/<transform_id>

GET _data_frame/transforms/<transform_id>,<transform_id>

GET _data_frame/transforms/

GET _data_frame/transforms/_all

GET _data_frame/transforms/*


  • If the Elasticsearch security features are enabled, you must have monitor_data_frame_transforms cluster privileges to use this API. The built-in data_frame_transforms_user role has these privileges. For more information, see Security privileges and Built-in roles.


You can get information for multiple transforms in a single API request by using a comma-separated list of identifiers or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

Path parametersedit

(Optional, string) Identifier for the transform. It can be a transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

Query parametersedit


(Optional, boolean) Specifies what to do when the request:

  • Contains wildcard expressions and there are no transforms that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

(Optional, integer) Skips the specified number of transforms. The default value is 0.
(Optional, integer) Specifies the maximum number of transforms to obtain. The default value is 100.

Response bodyedit

(array) An array of transform resources, which are sorted by the id value in ascending order. See Transform resources.

Response codesedit

404 (Missing resources)
If allow_no_match is false, this code indicates that there are no resources that match the request or only partial matches for the request.


The following example retrieves information about a maximum of ten transforms:

GET _data_frame/transforms?size=10

The following example gets configuration information for the ecommerce_transform transform:

GET _data_frame/transforms/ecommerce_transform

The API returns the following results:

  "count" : 1,
  "transforms" : [
      "id" : "ecommerce_transform",
      "source" : {
        "index" : [
        "query" : {
          "term" : {
            "geoip.continent_name" : {
              "value" : "Asia"
      "dest" : {
        "index" : "kibana_sample_data_ecommerce_transform"
      "frequency": "1m",
      "pivot" : {
        "group_by" : {
          "customer_id" : {
            "terms" : {
              "field" : "customer_id"
        "aggregations" : {
          "max_price" : {
            "max" : {
              "field" : "taxful_total_price"
      "description" : "Maximum priced ecommerce data by customer_id in Asia"