Query

POST

/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/query

A request to perform a query.

The request is composed of the following information:

• bucketQuery: A JSON object that contains:
• clause: The clause for the query. The details are explained in below.
• orderBy: The field used for aligning the query result. This field is optional.
• descending: A boolean field indicating whether the objects should be sorted in a descending or ascending order. This field works in pair with the "orderBy" and has no effect if the "orderBy" is not provided. This field is optional. If not provided, the field will be set to false by default.
• paginationKey: The pagination key for getting the next page of the query result. The key will be provided when the result is returned in the paginated manner.
• bestEffortLimit: The maximum number of objects to retrieve in one response.

• eq: Equality clause. Check if a field in the object has the specified value.
  The additional fields required for this clause are as follows:
• field: The name of the field.
• value: The value that the specified object field should have.
• prefix: Prefix clause. Only valid for string fields. Check if a string field starts with a specified prefix.
  The additional fields required for this clause are as follows:
• field: The name of the field.
• prefix: The prefix that the specified object field should start.
• and: Boolean clause that concatenates a list of clauses with an "AND" connector.
  The additional field for this clause is as follows:
• clauses: An array of clauses.
• or: Boolean clause that concatenates a list of clauses with an "OR" connector.
  The additional field for this clause is as follows:
• clauses: An array of clauses.
• all: All clause. This clause returns all objects in the bucket. This clause cannot be nested in other clauses (e.g., boolean clause or not clause).
• range: Range clause. Check if the value in the object field is in the specified range of values.
  The additional fields required for this clause are as follows (either the upper or the lower limit can be omitted, but not both):
• field: The name of the field.
• upperLimit: The upper limit of the range.
• upperIncluded: Boolean field that indicates if the upper limit is included in the range. The default value is "true".
• lowerLimit: The lower limit of the range.
• lowerIncluded: Boolean field that indicates if the lower limit is included in the range, The default value is "true".
• in: In clause. Check if the object field has one of the specified values.
  The additional fields for this clause are as follows:
• field: The name of the field.
• values: The list of values to match.
• not: Not clause. Returns all the objects that do not match with a given clause. The condition does not match if the specified field does not exist.
  The additional field for this clause is as follows:
• clause: The clause the objects should not match.
• hasField: "Has Field" clause. Check if the object has a specified field.
  The additional fields for this clause are as follows:
• field: The name of the field.
• fieldType: Type of the field. The possible values are "STRING", "INTEGER", "DECIMAL", and "BOOLEAN"
• geobox: "Within a box" clause. Allows to search objects in a given rectangle defined by the northeast and southwest points.
  The additional fields for this clause are as follows:
• field: The name of the field.
• box: JSON containing 2 properties of type point*:
• ne: North East point with its corresponding longitude and latitude.
• sw: South West point with its corresponding longitude and latitude.

* Point type: Contains the following fields:

• lat: Latitude. Decimal value in range ]-90, +90[
• lon: Longitude. Decimal value in range ]-180, +180[
• geodistance: "At a distance from point" clause. Allows to search objects that are at a given distance from a single point.
  The additional fields for this clause are as follows:
• field: The name of the field.
• center: The center.
• radius: The radius from the center in meters. The allowed value is from 0 to 20000000.
• putDistanceInto: The name of the field for storing the distance from the "center" in the query response. This field is optional. If this field is set, the field "_calculated" will be set for each object in the response. Inside this field, the field with the specified name will be set as the subfield with its value set to the distance from the "center" (in meter).

{
  "bucketQuery": "[BucketQuery]",
  "paginationKey": "[string]",
  "bestEffortLimit": "[string]"
}