IndexSearchCollection

Paginated list of documents found in a custom search index

type IndexSearchCollection {
  aggregations: Aggregations!
  current_page: Int!
  has_next_page: Boolean!
  has_previous_page: Boolean!
  per_page: Int!
  results: [Document!]
  total_entries: Int!
  total_pages: Int!
}

Fields

aggregations (Aggregations)

Results of the aggregations requested in the query, calculated over all matching documents

current_page (Int)

Number of the page returned in results

has_next_page (Boolean)

True when there is at least one page after the current one

has_previous_page (Boolean)

True when the current page is not the first one

per_page (Int)

Maximum number of results returned on a single page

results (Document)

Results on the current page

total_entries (Int)

Total number of results matching the query, across all pages

total_pages (Int)

Total number of pages, given per_page