Path parameters

• datafeed_id string | array[string] Required

  Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

Query parameters

• allow_no_match boolean

  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

    • assignment_explanation string

      For started datafeeds only, contains messages relating to the selection of a node.

    • datafeed_id string Required

      A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

    • node object

      For started datafeeds only, this information pertains to the node upon which the datafeed is started.

      Hide node attributes Show node attributes object

      • name string Required
      • ephemeral_id string Required
      • id string Required
      • transport_address string Required
      • attributes object Required
        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
    • state string Required

      The status of the datafeed, which can be one of the following values: starting, started, stopping, stopped.

      Values are started, stopped, starting, or stopping.

    • timing_stats object

      An object that provides statistical information about timing aspect of this datafeed.

      Hide timing_stats attributes Show timing_stats attributes object

      • bucket_count number Required

        The number of buckets processed.

      • exponential_average_calculation_context object
      • job_id string Required

        Identifier for the anomaly detection job.

      • search_count number Required

        The number of searches run by the datafeed.

    • running_state object

      An object containing the running state for this datafeed. It is only provided if the datafeed is started.

      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.

      • search_interval object

        Provides the latest time interval the datafeed has searched.