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

« xpack.ml.getFilters xpack.ml.getJobStats »

› ›

xpack.ml.getInfluencers

edit

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

xpack.ml.getInfluencers

edit

client.xpack.ml.getInfluencers({
  job_id: string,
  exclude_interim: boolean,
  from: number,
  size: number,
  start: string,
  end: string,
  influencer_score: number,
  sort: string,
  desc: boolean,
  body: object
})

Reference

`job_id` or `jobId`	`string` - undefined
`exclude_interim` or `excludeInterim`	`boolean` - Exclude interim results
`from`	`number` - skips a number of influencers
`size`	`number` - specifies a max number of influencers to get
`start`	`string` - start timestamp for the requested influencers
`end`	`string` - end timestamp for the requested influencers
`influencer_score` or `influencerScore`	`number` - influencer score threshold for the requested influencers
`sort`	`string` - sort field for the requested influencers
`desc`	`boolean` - whether the results should be sorted in decending order
`body`	`object` - Influencer selection criteria

« xpack.ml.getFilters xpack.ml.getJobStats »