WARNING: Version 6.1 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Post Data to Jobs API Revert Model Snapshots API »

› › ›

Preview Datafeeds API

This API enables you to preview a datafeed.

Request

GET _xpack/ml/datafeeds/<datafeed_id>/_preview

Description

The preview datafeeds API returns the first "page" of results from the search that is created by using the current datafeed settings. This preview shows the structure of the data that will be passed to the anomaly detection engine.

Path Parameters

datafeed_id (required): (string) Identifier for the datafeed

Authorization

You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example obtains a preview of the datafeed-farequote datafeed:

GET _xpack/ml/datafeeds/datafeed-farequote/_preview

The data that is returned for this example is as follows:

[
  {
    "@timestamp": 1454803200000,
    "airline": "AAL",
    "responsetime": 132.20460510253906
  },
  {
    "@timestamp": 1454803200000,
    "airline": "JZA",
    "responsetime": 990.4628295898438
  },
  {
    "@timestamp": 1454803200000,
    "airline": "JBU",
    "responsetime": 877.5927124023438
  },
  ...
]

« Post Data to Jobs API Revert Model Snapshots API »