NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

Elastic Docs ›Elasticsearch Node.js client [6.x] ›API Reference
« xpack.ml.forecast xpack.ml.getCalendarEvents »

xpack.ml.getBucketsedit

client.xpack.ml.getBuckets({
  job_id: string,
  timestamp: string,
  expand: boolean,
  exclude_interim: boolean,
  from: number,
  size: number,
  start: string,
  end: string,
  anomaly_score: number,
  sort: string,
  desc: boolean,
  body: object
})

Reference

job_id or jobId

string - ID of the job to get bucket results from

timestamp

string - The timestamp of the desired single bucket result

expand

boolean - Include anomaly records

exclude_interim or excludeInterim

boolean - Exclude interim results

from

number - skips a number of buckets

size

number - specifies a max number of buckets to get

start

string - Start time filter for buckets

end

string - End time filter for buckets

anomaly_score or anomalyScore

number - Filter for the most anomalous buckets

sort

string - Sort buckets by a particular field

desc

boolean - Set the sort direction

body

object - Bucket selection details if not provided in URI
« xpack.ml.forecast xpack.ml.getCalendarEvents »