GuidesAPI Reference
API Reference

Simple and fast access to your custom geofence attributes

Simple and fast access to your custom geofence attributes

Query Params
string
string
string

map name. If not specified, the content of all maps containing the requested layer(s) is retrieved

string
required

Comma separated list of layers to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via v8/maps/serviceconfiguration. Via the attributes parameter only certain column attributes from a layer can be returned.

string

Supported filtering options are tile and all(full layer). The format is &in=all or &in=tile:{comma separated list of tile ids}. In case of tile search, the number of tile ids must match with the number of requested layers.

string

A SQL expression is evaluated for each geometry returned from the specified layer listing. Column values for the geometry are available as defined variables. When specified, only geometries where expression evaluates to true will be returned. Supported SQL filter operators are: '=', '!=', '>', '<', 'AND', 'OR', 'LIKE'. Example: filter=RATING > 3 AND NAME != 'MyPlace23' AND NAME LIKE 'FOOD%'. Parameter value must be url encoded when using special characters. This filter expression is applied to all geometries, so it can become slow for big layers. To avoid service overload, filter expressions must not exceed 100 characters of text. Note:

  1. The filter expression is applied to all objects across all specified layers. Therefore, it is most likely to work as intended when a single layer is requested.
  2. The filter expression is not compatible with tile search. Tile search only allows filtering results based on attribute columns. Column filtering can be used to reduce response size.
string
Defaults to 1

When set to 1 then meta info is returned in the response. The default value is 1.

string

Semicolon separated list of column names (in uppercase) to specify which attributes shall appear in the result. If the request specifies several layers, then pass this for each layer, as a comma separated list. Default = all.

string

The number of geometries in the response. If more geometries satisfy the search/filter criteria, they will be suppressed. It is undefined, which of the matching geometries are returned, unless this parameter is used together with offset, which sorts the results set by geometry id. Parameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layers parameter. The maximum number of records supported within a single request can be looked up in the v8/maps/serviceconfiguration endpoint. This parameter can only be used with &in=all filter to download the custom layers.

string

To paginate huge responses, this parameter specifies the lowest geometry id to be returned. If geometry ids are not known, then retrieve the first page using zero, and to retrieve subsequent pages then request highest geometry of current page + 1 (it doesn't matter whether this geometry id actually exists or not). Use this parameter together with count parameter. Parameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layers parameter. This parameter can only be used with &in=all filter to download custom layers.

string

Optional. If this parameter is set to true, user will get list of geometries from available layers, even if some of the requested layers are missing. If none of the requested layers are found, service returns empty list.

string

Owner app_id that was used to upload a layer. It is mandatory when a granted app_id is used to access the layer.

Response

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8