Get datafeeds usage info Added in 5.5.0

GET /_ml/datafeeds/_stats

You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the only information you receive is the datafeed_id and the state. This API returns a maximum of 10,000 datafeeds.

Query parameters

  • Specifies what to do when the request:

    1. Contains wildcard expressions and there are no datafeeds that match.
    2. Contains the _all string or no identifiers and there are no matches.
    3. Contains wildcard expressions and there are only partial matches.

    The default value is true, which returns an empty datafeeds 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.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • count number Required
    • datafeeds array[object] Required
      Hide datafeeds attributes Show datafeeds attributes object
      • For started datafeeds only, contains messages relating to the selection of a node.

      • datafeed_id string Required
      • node object

        Additional properties are allowed.

        Hide node attributes Show node attributes object
      • state string Required

        Values are started, stopped, starting, or stopping.

      • timing_stats object Required

        Additional properties are allowed.

        Hide timing_stats attributes Show timing_stats attributes object
      • Additional properties are allowed.

        Hide running_state attributes Show running_state attributes object
        • real_time_configured boolean Required

          Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured end time.

        • real_time_running boolean Required

          Indicates whether the datafeed has finished running on the available past data. For datafeeds without a configured end time, this means that the datafeed is now running on "real-time" data.

        • Additional properties are allowed.

          Hide search_interval attributes Show search_interval attributes object
          • end string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • end_ms number

            Time unit for milliseconds

          • start string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • start_ms number

            Time unit for milliseconds

GET /_ml/datafeeds/_stats
curl \
 -X GET http://api.example.com/_ml/datafeeds/_stats
Response examples (200)
{
  "count": 42.0,
  "datafeeds": [
    {
      "assignment_explanation": "string",
      "datafeed_id": "string",
      "node": {
        "attributes": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "ephemeral_id": "string",
        "id": "string",
        "name": "string",
        "transport_address": "string"
      },
      "state": "started",
      "timing_stats": {
        "bucket_count": 42.0,
        "": 42.0,
        "job_id": "string",
        "search_count": 42.0
      },
      "running_state": {
        "real_time_configured": true,
        "real_time_running": true,
        "search_interval": {
          "end": "string",
          "": 42.0,
          "start": "string"
        }
      }
    }
  ]
}