documents

Searches documents in the custom search index of the instance (configured with
search_indexes in app/config.yml and filled with documents_insert,
documents_upsert and documents_bulk_upsert) by full-text query, filters and aggregations.

documents(
  aggregations: [ListingAggregation]
  filter: [IndexSearchFilterInput!]
  page: Int = 1
  per_page: Int!
  query: IndexSearchQuery
  search_index: String!
  sort: [IndexSearchSortInput!]
): IndexSearchCollection!

Arguments

aggregations (ListingAggregation)

Aggregations (e.g. counts of documents per field value) to calculate over the matching documents

filter (IndexSearchFilterInput)

Conditions on document fields. All conditions are combined with AND

page (Int)

Page number to return, starting at 1. page multiplied by per_page cannot
exceed the result window of the search index; within it, a page beyond the
last one returns an empty results list

per_page (Int)

Number of results per page, must be greater than 0

query (IndexSearchQuery)

Full-text search query

search_index (String)

Name of the search index the documents were inserted with

sort (IndexSearchSortInput)

Sort order of the results. When several entries are given, they are applied in the given order

Type

IndexSearchCollection

Paginated list of documents found in a custom search index