Contains multiple documents.
Field | Type | Description |
object_type | string | "documents" |
is_valid | true/false | true if this contains at least one document |
prepended | list of documents | documents that will be listed at the beginning of the items list |
fetched | list of documents | The primary list of documents to be included in the items list |
appended | list of documents | documents that will be listed at the end of the items list |
appended_unique | list of documents | documents that will be listed at the end of the items list, excluding any documents that are already included in either the prepended or fetched lists |
items | list of documents | The full list of documents in the proper order and uniqueness, including prepended, fetched, and appended documents |
size | number | The total number of items in the list of items, including prepended, fetched, and appended documents |
limit | number | The maximum number of documents that could have been fetched dynamically from the database |
start | number | The 1-based index of the first document that was (or would have been) dynamically fetched from the database |
page | number | The 1-based index of the first "page" of documents that could have been fetched dynamically from the database - as determined by the start and limit properties |
total_count | number | The total number of documents in the database that matched the provided filter parameters when fetching the list of fetched documents |
total_pages | number | The total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched documents - as determined by the total_count and limit properties |
output | html | The default output that the documents will produce when it is output directly to the template - using the "output_in_list" property of each document in the items list |