A valid request URL is required to generate request examples{
"documents": {
"id": 1,
"contents": {
"name": "Francis",
"favoriteBook": {
"title": "The Great Gatsby",
"published": 1925
}
}
},
"txnId": 9000
}{
"message": "Some kind of human readable description of the error"
}{
"message": "Some kind of human readable description of the error"
}{
"message": "Some kind of human readable description of the error"
}Find docs with Legacy QL
Query documents in a collection using a flexible query language. This endpoint supports pagination, sorting, and complex queries to help you efficiently retrieve exactly the data you need.
A valid request URL is required to generate request examples{
"documents": {
"id": 1,
"contents": {
"name": "Francis",
"favoriteBook": {
"title": "The Great Gatsby",
"published": 1925
}
}
},
"txnId": 9000
}{
"message": "Some kind of human readable description of the error"
}{
"message": "Some kind of human readable description of the error"
}{
"message": "Some kind of human readable description of the error"
}Authorizations
Authentication using either an API key or JWT token in the Authorization header
Headers
Optional transaction ID that ensures read consistency. The operation will only proceed if the Big Peer's transaction ID is at least this value, preventing reads of stale data.
Body
Specify the collection to query, the query conditions, and optional parameters like limit, offset, and sort order. The query can be parameterized using the args field for safe and efficient execution.
Request parameters for querying documents in a collection. Supports filtering, pagination, and sorting to help you retrieve exactly the data you need.
The name of the collection to query
The query expression that filters which documents to return. Use parameterized values with :param syntax for better security and performance.
Named parameters to use in the query, providing safe value substitution and better query performance
When true, includes additional metadata about the query execution
When true, formats any attachment fields for easier consumption
Maximum number of documents to return. Use with offset for pagination.
Number of documents to skip before starting to return results. Use with limit for pagination.
Controls how the document data is serialized in the response
latestValues, latestValuesAndTypes Specifies the order in which to return matching documents
Show child attributes
Show child attributes
Response
The query executed successfully. Returns an array of matching documents and the transaction ID of the read operation. If no documents match, the documents array will be empty.
Was this page helpful?