PaginatedSearchResult
Document representing a generic search result. Each search resource should extend this to define what is returned in the hits
.
sorts
array
The sorting that was applied to the result.
hits
array
The sorted array of search hits. Can be empty.
query
object
Required
The query that is passed into the search.
limit
integer
Required
Maximum records to retrieve per request, not to exceed 200.
Default value:
10
Min value:
1
Max value:
200
offset
long
Required
Used to retrieve the results based on a particular resource offset.
Default value:
0
Min value:
0
total
long
Required
The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
Default value:
0
Min value:
0