rest-api-spec.api.ml.get_categories.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_categories":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html",
"description":"Retrieves anomaly detection job results for one or more categories."
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}",
"methods":[
"GET",
"POST"
],
"parts":{
"job_id":{
"type":"string",
"description":"The name of the job"
},
"category_id":{
"type":"long",
"description":"The identifier of the category definition of interest"
}
}
},
{
"path":"/_ml/anomaly_detectors/{job_id}/results/categories",
"methods":[
"GET",
"POST"
],
"parts":{
"job_id":{
"type":"string",
"description":"The name of the job"
}
}
}
]
},
"params":{
"from":{
"type":"int",
"description":"skips a number of categories"
},
"size":{
"type":"int",
"description":"specifies a max number of categories to get"
},
"partition_field_value":{
"type":"string",
"description":"Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled."
}
},
"body":{
"description":"Category selection details if not provided in URI"
}
}
}