rest-api-spec.api.ml.get_buckets.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation
Show all versions of rest-api-spec Show documentation
Elasticsearch subproject :rest-api-spec
{
"ml.get_buckets":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html",
"description":"Retrieves anomaly detection job results for one or more buckets."
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}",
"methods":[
"GET",
"POST"
],
"parts":{
"job_id":{
"type":"string",
"description":"ID of the job to get bucket results from"
},
"timestamp":{
"type":"string",
"description":"The timestamp of the desired single bucket result"
}
}
},
{
"path":"/_ml/anomaly_detectors/{job_id}/results/buckets",
"methods":[
"GET",
"POST"
],
"parts":{
"job_id":{
"type":"string",
"description":"ID of the job to get bucket results from"
}
}
}
]
},
"params":{
"expand":{
"type":"boolean",
"description":"Include anomaly records"
},
"exclude_interim":{
"type":"boolean",
"description":"Exclude interim results"
},
"from":{
"type":"int",
"description":"skips a number of buckets"
},
"size":{
"type":"int",
"description":"specifies a max number of buckets to get"
},
"start":{
"type":"string",
"description":"Start time filter for buckets"
},
"end":{
"type":"string",
"description":"End time filter for buckets"
},
"anomaly_score":{
"type":"double",
"description":"Filter for the most anomalous buckets"
},
"sort":{
"type":"string",
"description":"Sort buckets by a particular field"
},
"desc":{
"type":"boolean",
"description":"Set the sort direction"
}
},
"body":{
"description":"Bucket selection details if not provided in URI"
}
}
}