GetPercentiles
Groups the aggregated values that match the query into percentile groupings. The default
percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own
when you call GetPercentiles. This function returns a value for each
percentile group specified (or the default percentile groupings). The percentile group
"1" contains the aggregated field value that occurs in approximately one percent of the
values that match the query. The percentile group "5" contains the aggregated field value
that occurs in approximately five percent of the values that match the query, and so on.
The result is an approximation, the more values that match the query, the more accurate
the percentile values.
Requires permission to access the GetPercentiles action.
Request Syntax
POST /indices/percentiles HTTP/1.1
Content-type: application/json
{
"aggregationField": "string",
"indexName": "string",
"percents": [ number ],
"queryString": "string",
"queryVersion": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- aggregationField
-
The field to aggregate.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- indexName
-
The name of the index to search.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: No
- percents
-
The percentile groups returned.
Type: Array of doubles
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- queryString
-
The search query string.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- queryVersion
-
The query version.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"percentiles": [
{
"percent": number,
"value": number
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- percentiles
-
The percentile values of the aggregated fields.
Type: Array of PercentPair objects
Errors
- IndexNotReadyException
-
The index is not ready.
HTTP Status Code: 400
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidAggregationException
-
The aggregation is invalid.
HTTP Status Code: 400
- InvalidQueryException
-
The query is invalid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
