Get transforms API
editGet transforms API
editRetrieves 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.
Request
editGET _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/*
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have
monitor_data_frame_transformscluster privileges to use this API. The built-indata_frame_transforms_userrole has these privileges. For more information, see Security privileges and Built-in roles.
Description
editYou 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 parameters
edit-
<transform_id> - (string) Optional. 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 parameters
edit-
from -
(integer) Optional. Skips the specified number of transforms.
The default value is
0. -
size -
(integer) Optional. Specifies the maximum number of transforms
to obtain. The default value is
100.
Response body
edit-
transforms -
(array) An array of transform resources, which are sorted by the
idvalue in ascending order.
Examples
editThe 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" : [
"kibana_sample_data_ecommerce"
],
"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"
}
]
}