New article
Recently updated
Understanding Search API stat objects
Who is this article for?
Users who need to search records that meet a variety of requirements and assist with populating data repositories
Restricted access to Users with interface development roles. It is a read-only HTTP/JSON API.
Search API statistical objects are used to conduct a variety of statistical operations on the queried data. These operations may encompass:
| Key | Type | Description |
|---|---|---|
field |
String |
The field to perform the stat operations on |
sum |
Boolean |
Sum the values in the requested field |
min |
Boolean |
Returns the lowest value in the field |
max |
Boolean |
Returns the maximum value in the field |
mean |
Boolean |
Returns the mean value of all the values in the field |
count |
Boolean |
total count of all documents that have a value in the field |
stddev |
Boolean |
Standard deviation, measuring how widely spread the values in the data set are. This statistic is computed for numeric and date field types |
sumOfSquares |
Boolean |
Sum of all values squared (a byproduct of computing stddev). This statistic is computed for numeric and date field types |
tags |
List of Strings |
List of tags to use with facet pivoting. if pivoting matches a stat tag, that stat will be done on those matching documents |
Statistical objects will return all defined fields if no filters are explicitly specified. Adding flags will refine and condense the results.
These statistical objects help in aggregating and analyzing data, providing insights into the dataset being queried.