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

« xpack.ml.getModelSnapshots xpack.ml.getRecords »

› ›

xpack.ml.getOverallBuckets

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

xpack.ml.getOverallBuckets

edit

client.xpack.ml.getOverallBuckets({
  job_id: string,
  top_n: number,
  bucket_span: string,
  overall_score: number,
  exclude_interim: boolean,
  start: string,
  end: string,
  allow_no_jobs: boolean,
  body: object
})

Reference

`job_id` or `jobId`	`string` - The job IDs for which to calculate overall bucket results
`top_n` or `topN`	`number` - The number of top job bucket scores to be used in the overall_score calculation
`bucket_span` or `bucketSpan`	`string` - The span of the overall buckets. Defaults to the longest job bucket_span
`overall_score` or `overallScore`	`number` - Returns overall buckets with overall scores higher than this value
`exclude_interim` or `excludeInterim`	`boolean` - If true overall buckets that include interim buckets will be excluded
`start`	`string` - Returns overall buckets with timestamps after this time
`end`	`string` - Returns overall buckets with timestamps earlier than this time
`allow_no_jobs` or `allowNoJobs`	`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
`body`	`object` - Overall bucket selection details if not provided in URI

« xpack.ml.getModelSnapshots xpack.ml.getRecords »