API Reference / API Parameters / percentileComputation

Nov. 25, 2021

percentileComputation

Type: boolean

Engine default: true

Parameter syntax

'percentileComputation' => true|false

percentileComputation: true|false

percentileComputation: true|false

'percentileComputation': True|False

percentileComputation = true|false

percentileComputation: Boolean = true|false

.PercentileComputation: true|false

.setPercentileComputation(true|false)

opt.PercentileComputation(true|false)

percentileComputation = Some(true|false)

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Whether to include or exclude a query from the processing-time percentile computation.

Usage notes

When true, the API saves the processing time of the search query and includes it when computing the 90% and 99% percentiles, available in your Algolia dashboard.
When false, the search query is excluded from the percentile computation.

Examples

Exclude the query from the percentile computation

Copy

1
2
3
$results = $index->search('query', [
  'percentileComputation' => false
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.percentileComputation, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Did you find this page helpful?