<commit_before>//lcawley Verified example output 2017-04-11
[[ml-get-datafeed-stats]]
=== Get {dfeed-cap} Statistics

The get {dfeed} statistics API enables you to retrieve usage information for
{dfeeds}.


==== Request

`GET _xpack/ml/datafeeds/_stats` +

`GET _xpack/ml/datafeeds/<feed_id>/_stats`


==== Description

If the {dfeed} is stopped, the only information you receive is the
`datafeed_id` and the `state`.


==== Path Parameters

`feed_id`::
  (string) Identifier for the {dfeed}.
  This parameter does not support wildcards, but you can specify `_all` or
  omit the `feed_id` to get information about all {dfeeds}.


==== Results

The API returns the following information:

`datafeeds`::
  (array) An array of {dfeed} count objects.
  For more information, see <<ml-datafeed-counts>>.


==== Authorization

You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see <<privileges-list-cluster>>.


==== Examples

The following example gets usage information for the
`datafeed-farequote` {dfeed}:

[source,js]
--------------------------------------------------
GET _xpack/ml/datafeeds/datafeed-farequote/_stats
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

The API returns the following results:
[source,js]
----
{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-farequote",
      "state": "started",
      "node": {
        "id": "IO_gxe2_S8mrzu7OpmK5Jw",
        "name": "IO_gxe2",
        "ephemeral_id": "KHMWPZoMToOzSsZY9lDDgQ",
        "transport_address": "127.0.0.1:9300",
        "attributes": {
          "max_running_jobs": "10"
        }
      },
      "assignment_explanation": ""
    }
  ]
}
----<commit_msg>[DOCS] Update get datafeed statistics API output (elastic/x-pack-elasticsearch#1678)<commit_after>//lcawley Verified example output 2017-04-11
[[ml-get-datafeed-stats]]
=== Get {dfeed-cap} Statistics

The get {dfeed} statistics API enables you to retrieve usage information for
{dfeeds}.


==== Request

`GET _xpack/ml/datafeeds/_stats` +

`GET _xpack/ml/datafeeds/<feed_id>/_stats`


==== Description

If the {dfeed} is stopped, the only information you receive is the
`datafeed_id` and the `state`.


==== Path Parameters

`feed_id`::
  (string) Identifier for the {dfeed}.
  This parameter does not support wildcards, but you can specify `_all` or
  omit the `feed_id` to get information about all {dfeeds}.


==== Results

The API returns the following information:

`datafeeds`::
  (array) An array of {dfeed} count objects.
  For more information, see <<ml-datafeed-counts>>.


==== Authorization

You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see <<privileges-list-cluster>>.


==== Examples

The following example gets usage information for the
`datafeed-farequote` {dfeed}:

[source,js]
--------------------------------------------------
GET _xpack/ml/datafeeds/datafeed-farequote/_stats
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

The API returns the following results:
[source,js]
----
{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-farequote",
      "state": "started",
      "node": {
        "id": "IO_gxe2_S8mrzu7OpmK5Jw",
        "name": "IO_gxe2",
        "ephemeral_id": "KHMWPZoMToOzSsZY9lDDgQ",
        "transport_address": "127.0.0.1:9300",
        "attributes": {
          "ml.enabled": "true"
        }
      },
      "assignment_explanation": ""
    }
  ]
}
----
{'fraction_non_alphanumeric': 0.1890533370566881, 'fraction_numerical': 0.015638089919017033, 'mean_word_length': 2.8106382978723405, 'pattern_counts': {'":': 24, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4134', 'n_tokens_mistral': 1224, 'n_tokens_neox': 1167, 'n_words': 319}