The Open API specification for Synapse is now available for download!

Download Open API Spec

FacetRequest

org.sagebionetworks.repo.model.search.FacetRequest

A request to aggregate a column as a facet in search results.

Field Type Description
columnName STRING The name of the column to aggregate.
maxValueCount INTEGER Maximum number of facet values to return. Default: 25.
sortField FacetSortField The field to sort facet values by in a terms aggregation.
sortDirection SortDirection Sort direction for search results.