Get data frame transforms APIedit


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.

Retrieves configuration information for data frame transforms.


GET _data_frame/transforms/<data_frame_transform_id>

GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>

GET _data_frame/transforms/

GET _data_frame/transforms/_all

GET _data_frame/transforms/*

Path Parametersedit

(string) Identifier for the data frame transform. It can be a data frame transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all data frame transforms.
(integer) Skips the specified number of data frame transforms. The default value is 0.
(integer) Specifies the maximum number of data frame transforms to obtain. The default value is 100.


The API returns the following information:

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


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.


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 data frame 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"
      "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"