get
https://api.quickblox.com/data/.json
Search for records of a particular class.
Recipes
Filter records by location
Open Recipe
Filter records by criteria
Open Recipe
Group records
Open Recipe
If you are sorting records by time, use the
_idfield. It is indexed and will be much faster than thecreated_atfield.
Combinations of operators are allowed. For example: score_value[gt]=100&score_value[lt]=1000&game_mode_name[in]=deathmatch,ctf)
Search Operators
The request can contain all, some or none of the next search operators:
| Operator | Description |
|---|---|
| lt | Less Than operator Types: integer, float Example: score_value[lt]=1000 |
| lte | Less Than or Equal to operator Types: integer, float Example: score_value[lte]=850 |
| gt | Greater Than operator Types: integer, float Example: bonus_count[gt]=2.45 |
| gte | Greater Than or Equal to operator Types: integer, float Example: bonus_count[gte]=56.443 |
| ne | Not Equal to operator Types: integer, float, string, boolean Example: game_mode_name[ne]=ctf |
| in | Contained IN array operator Types: integer, float, string Example: game_mode_name[in]=deathmatch,rage |
| nin | Not contained IN array operator Types: integer, float, string Example: game_mode_name[nin]=survivor,crazy_nightmare |
| all | ALL contained IN array operator Types: array Example: game_modes[all]=survivor,crazy |
| or | OR operator Types: integer, float, string Example: name[or]=sam,tim name[or]=sam&lastname[or]=johnson Will return records with name sam or tim.Will return records with name sam or last name johnson. |
| ctn | Contains substring operator Types: string Example: username[ctn]=son Will return all records where username field contains son substring. |
| near | Types: location Example: mylocation[near]=25.32,44.551;1000 Search records in a specific radius with the current position in meters. Format: {field_name}[near]=longitude,latitude;radius. |
Sort Operators
Next sorting operators are allowed:
| Operator | Description |
|---|---|
| sort_asc | Types: all types Example: sort_asc=field_name Search results will be sorted by the specified field in ascending order. |
| sort_desc | Types: all types Example: sort_desc=field_name Search results will be sorted by the specified field in descending order. |
Aggregation Operators
Next aggregation operators are for performing aggregation tasks:
| Operator | Description |
|---|---|
| {field_name}[calc]= | Types: integer, float Example: rating[calc]=min avg, min, max, sum can be used with group_by operator. |
| group_by={field_name} | Types: integer, float, string, boolean Example: group_by=game_mode_name The group_by works similarly to the SQL GROUP BY operator, should be used with the calc operator. |
