ResultSetMetadata Data Type

Information about a result set of a search query.

Properties
name data type constraints description
count number required int Number of total results for the search query.
from number required int Pagination - First result in this response.
size number required int Pagination - Number of results returned with this response.
truncated boolean required boolean A flag to indicate whether the result set is truncated. This can happen if the calculation of related objects was too computationally intensive.

Example

{
  "count" : 10,
  "from" : 2,
  "size" : 8,
  "truncated" : true
}