List of cluster definitions. Only supported for node requests. With node requests, when zoomed far out, some POIs that are close to each other are clustered to be displayed as a single geometry. With this parameter, one can define different cluster groups. Each cluster name must start with `c_`, and its value corresponds to one osmType or one POIGroup that this cluster group contains. It is possible to define a cluster group for several POIGroups or osmTypes via the request string `"c_1=g_food&c_1=g_electro"` for example. This cluster definition enables then to know how many POI of the different cluster definitions are contained in each cluster geometry. If some POIs belong to no clusters definition, they will be counted in `c_other`.

clusters

List of OSM tags (separated by `=`) or group id of the POI hierarchy (for example `g_electro` or `computer`) that must not appear in the response.

exclude

Difference between the zoom level of the map and the one used to build the geometries.

layerGeometryDetailPerTile

Maximum zoom level used to build the geometries.

layerMaxGeometryDetailLevel

Minimum zoom level used to build the geometries.

layerMinGeometryDetailLevel

layerType

Whether or not to retrieve all tags of the POIs.

loadAllTags

Type of match for the combination of tags. `match=any` (by default if not specified) means that the service will retrieve all POIs that contain at least one tag of the request. `match=all` means that it will retrieve all POIs that contain all tags of the request.

match

maxGeometryCount

This object is a key-value-combination of OSM map feature tags. See [OSM map features](http://wiki.openstreetmap.org/wiki/Map_Features) for a complete list of features.

This represents the top level categories, e.g. _amenity_, _building_ or _leisure_.

This represents the elements available for a top level category, e.g. _bar_, _fastfood_ or pub_ for _amenity_.

OsmType

OSM tags key-value pair(s). See [OSM map features](http://wiki.openstreetmap.org/wiki/Map_Features) for a complete list of features.  A wildcard (_*_) can also be used to retrieve all POIs that contain one key. For example, "cuisine=*"

osmType

group

statisticsGroupId

Specifies factors with which the travel times of the edges are adjusted. This may be necessary in certain areas where the travel time calculation is almost always off by a certain factor, e.g. Paris rush hour. "travelTimeFactors" : {
 "all":0.5,
 "motorway":1.5,
 .... (other specific edge classes possible)
},.. Further specifics about the TravelTimeFactors:
* travel time factor of 1.5 means 50% more time is needed
* travel time factor 'all' is applied to ALL edge classes (on top of a specified one, e.g. for the example above 1.5*0.5=0.75 - the final applied travel time factor for 'motorway' edges)
* all elements are optional, min allowed cumulative travel time factor is 0.5; maximum allowed cumulative travel time factor is 100.0
* elements that are not recognized are ignored
* transit travel times are not affected by the travelTimeFactors

Has an effect on all edge classes (excluding transit travel times)

The user can also specify the factor for certain road types, i.e. edge classes. In the following is a list of possible road types for which a travel time factor can be individually specified: ['motorway', 'motorway_link', 'trunk', 'trunk_link', 'primary', 'primary_link', 'secondary', 'secondary_link', 'tertiary', 'residential', 'tertiary_link', 'road', 'unclassified', 'service', 'living_street', 'pedestrian', 'track', 'path', 'cycleway', 'footway', 'steps', 'unknown']

The Mode of Transportation used by the Targomo API

The travel type bound to the Statistics Group

travelType

uuid

Same like uphill but for downhill (might be negative because the distance can be closed quicker when downhill)

Assumed walking speed to and from transit public stations in km/h.

Uphill penalty specifies by how much a distance is enhanced per one meter increase in elevation. E.g. an uphill penalty of 20 means that per one meter increase in elevation the distance is increased by 20 meters.

An Array of user IDs active in the given period.

This is the Targomo API (service) key that you receive once you are registered at [targomo.com/developers](https://www.targomo.com/developers/).

apiKey

Determines the geometry buffer size of the original polygon edges. The newly created polygon is wider by that  margin. If specified it has to be greater than 0.0; If no simplify is specified it will force a simplify value.  If nothing is specified no buffer will be added.

Common category for all the POIs of the file.  Either `categoryProperty` or `categoryForAll` is required.

categoryForAll

Property (or column label) that needs to be taken as a category.  Either `categoryProperty` or `categoryForAll` is required.

categoryProperty

JSON Configuration as query parameter. Should follow ReachabilityRequestConfiguration format [(See here)](#tag/Places-Context-API/paths/~1pointofinterest~1reachability/post) or GeometryRequestConfiguration format [(See here)](#tag/Places-Context-API/paths/~1pointofinterest~1geometry/post).

collection

collections

Columns to return other than geom. The default is no columns.

columns

The date the containing object was created.

criterionId

The coordinate reference system used in the object. Must be the EPSG number. For example WGS84/EPSG:4326 would be represented by `4326`.

CRS (Coordinate Reference System) of the POIs of the file

Id of the dataset you want to import the POIs into.

datasetId

This is the date on which the routing should take place. This is formatted like: YYYYMMDD, e.g. for the first of August: 20170801 This is an optional parameter. If at least one of the parameters `date` and `time` is set, the driving speed will be adjusted according to the time and the day of the week. In this case the `rushHour` flag will be ignored.

The date covered by the information in the containing object.

day_end

day_start

Determines the dimension of the edges' weight, i.e. time (distance in seconds) or distance (distance in meters). `distance` Will optimize for distance and search for the shortest path, `time` will optimize for time and will search for the fastest path. Distance cannot be used in concert with travelType `transit`.

Whether or not the an elevation heuristic will be used (e.g. downhill with bike quicker than uphill).

endpoint

epsg

The exclusion geometry describes a GeoJSON object that should not be traveled through during the routing calculation. Any  edges That intersect with the described geometry will be excluded from the routing. This can be used to simulate temporarily  impassible routes or to deliberatley exclude certain ways. Both 'data' and 'crs' must be defined and do not have default values.

The string version of the GeoJSON Geometry that defines the area of exlcusion

The geometry column of the table. Must be SRID 3857.

geom_column

group results by 'type', 'travelType', 'group' or 'statistic'

groupBy

The period of time to over which the query is grouped

groupId

hour_end

hour_start

Property (or column label) that needs to be taken as a unique id.

idProperty

includePrivate

If `categoryProperty` is different from `category`, setting this parameter as `true` will keep the information as the original tag as well.

keepOriginalCategoryTag

If `nameProperty` is different from `name`, setting this parameter as `true` will keep the information as the original tag as well.

keepOriginalNameTag

The latitude/y Coordinate in the WGS84/EPSG:4326 coordinate system. An example for Berlin would be `52.52`.

How many of the time period specified by the request to cover. E.g. If the request covers months a limit of 3  would cover 3 months.

limit

The longitude/x Coordinate in the WGS84/EPSG:4326 coordinate system. An example for Berlin would be `13.405``

max_duration

The maximum distance "depth" of the built network in seconds (for edgeWeight = time) or meters (for edgeWeight = distance). lower max edge weights limit the size of the networked and the area covered, while greater values will increase the time taken to process the request. The upper limit of this variable is based on your subscription plan and differs between  distance and time.

This defines the maximum distance allowed (in meters) between a defined source/target and the nearest point in the network it will connect. Any point that has a distance exceeding maxSnapDistance is treated like a point that exceeds maxEdgeWeight. If set too low points will be unable to snap to any nearby edges, if set too high points set outside the network or where lat/long have been accidentally inverted will be able to snap to the outer edge of the network.

Optional parameter to limit the number of transfers between different public transport lines/vehicles. Routing will not change public  transport when the shortest possible route has reached the transfer limit. This may lead to some possible routes not being found.
Valid values: [0..127]. If the parameter is not present, the number of transfers is unlimited.

The maximum duration (in seconds) for walking before entering transit. If the value is -1, the duration is unlimited.

The maximum duration (in seconds) for walking after leaving transit. If the value is -1, the duration is unlimited. This option  is currently only implemented for the timeVector API and is ignored otherwise.

min_duration

Set this as `true` if the importer must check that all POIs of the file have a name.

mustHaveName

Property (or column label) that can be taken as a name for the POI.

nameProperty

The North East X (longitude) coordinate of the desired bounding box.

northEastX

The North East Y (latitude) coordinate of the desired bounding box.

northEastY

The end date of the total aggregation period for the query

The start date of the total aggregation period for the query

The Plan of the user, for new users it should be one of TRIAL, PAY_AS_YOU_GO or LOOP_NEW

plan

The Plan of the user, different plans have different restrictions. Most plans are kept for legacy reasons, new users  should be one of TRIAL, PAY_AS_YOU_GO or LOOP_NEW.

A map of plans to the number of users. If no users were found for a given plan it will not be shown.

The ID of one of the POI Datasets used by the POI Service

poiIds

The access level of the group. Public means that any user has complete access to the group. Metadata means  that any user can see the group exists and access some basic metadata about the group, but only users given  specific access can use the group for statistics analysis. Private means that only users given specific  access can see anything about the group.

Optional multiplier for rendering HiDPI (retina) tiles

radius

Rating Id

ratingId

map of request types to the number of requests made

If true then the response also return all staypoints detail information.

return_staypoints

If the reverse flag is set to true, the routing algorithm will invert direction restrictions (one way roads, turning restrictions, ect) to simulate a to the source(s). For polygon routing this can be used to calculate  the polygon/area that could reach the source(s).

Enable the rush hour mode to simulate a more crowded street. _Warning_ this is a paid feature so not all plans are allowed to enable it. If at least one of the parameters `date` and `time` is set, the driving speed will be adjusted according to the time and the day of the week. In this case the `rushHour` flag will be ignored.

The scope of operations of the user, if it will be used for the API services or mainly used by LOOP.

serialization format - must be _mvt_ or _geojson_

serializationFormat

This is the Targomo APi key (serviceKey) that you receive once you are registered at [targomo.com/developers](https://www.targomo.com/developers/). For other requests this is specified as query parameter.

This is the service URL to which the other dependant Targomo requests  are dispatched (e.g Targomo Time or  Routing requestrs). The endpoint has to correspond to the addresses, e.g. if you want to execute Vehicle  Routing in France you need to point to an Targomo Endpoint that includes France geographically.

defines the core api server address to be used

serviceUrl

Ask for the details about the geographical elements that were used to calculate a score (for example: closest POIs...)

showDetails

display information on snap distances in the response. Currently only available for Route, Time and reachability APIs

The simplify (meters) parameter needs to be larger than 0m and smaller or equal to 500m. If not specified it  will be calculated from the buffer size (if it was specified).

sizeInMB

How many of the time period specified by the request to skip. E.g. If the request covers weeks a skip of 3 would  cover ignore the first 3 months.

skip

How many of the time period specified by the request to skip. E.g. If the request covers weeks a skip of 3 would  cover ignore the first 3 months. Can be negative in which case it will go back a month.

The South West X (longitude) coordinate of the desired bounding box.

southWestX

The South West Y (latitude) coordinate of the desired bounding box.

southWestY

The id of this object. 
This is typically used to find a marker/object after it has been processed and a travel time was attached to it, in a client application.

statGroup

style

If true also return the sum of all column values. The default is false.

sumColumns

This is the starting time for the routing in seconds from midnight. For example if the routing should start at 5.15pm this equals 17 * 3600s + 15 * 60s = 61200 This is an optional parameter. If at least one of the parameters `date` and `time` is set, the driving speed will be adjusted according to the time and the day of the week. In this case the `rushHour` flag will be ignored.

This field defines what travel mode is used for routing. All travel modes are build similarly but differ in some way, 'rush-hour' for 'car' or the 'date/time' for 'transit'.

travel mode

topic

Penalty (in seconds) for routing over a junction. All penalties are halved when staying on the main road.

Penalty (in seconds) for turning left. All penalties are halved when staying on the main road. The default is 4 for the endpoints `britishisles`, `australia`, `africa_middle_east`, and `asia`.

Penalty (in seconds) for turning right. All penalties are halved when staying on the main road. The default is 7 for the endpoints `britishisles` and `australia`.

Penalty (in seconds) for routing over a signal. All penalties are halved when staying on the main road.

If true then the response only return distinct (different) users.

unique

List of URLs whitelisted for a given API key of a user. These URLs are transformed into, and validated as, specialised regex by the API Key Service. Whitelisted URLs must be either HTTP or HTTPS and are otherwise matched literally with the exception of * characters  which are treated as wildcards which allow any digit, letter, -(dash), _(underscore) and /(forward slash). When returned in responses the whitelist URLs are returned as regex patterns.

urlWhitelist

A map of Product IDs to usage over a given period of time

Usage of Multigraph (standard and tiled), POI reachability, Statistics (reachability, geometry).

Usage of Polygons and Time/Time Vector APIs

Usage of Basemaps, POI Tiles, Vector Tiles

One of the API Keys of the user to be queried.

The unique ID of the user, separate from the API Key

userId

The API Key to be modified/added/added to by the query.

zoom

Object in the API Key array that shows the key itself, as well as when it was created and the URLs whitelisted for it

The regex to match whitelisted URLs for using this key

Stores, Orders, and Transports/Vehicles have addresses associated to determine their location. Preferably these addresses are already geo-coded in the WGS84 format (in lat, lng). Otherwise, the geo-coordinates are calculated during the request from the other address details (street, city, etc.). This only happens for order addresses. For store and start or endDestination addresses geo-coordinates (lat, lng) must exist already.

Amount of time it takes to carry out the order for this address in seconds. This value is only important for addresses in orders.

The User Operations for all users aggregated over a given period of time.

List of osm types or POI groups to exclude from the response.

List of osm types or POI groups to request.

Defines how the score is weighted by the distance of each reachable object.
The more negative it is the more the closest object from the location influences the score.
Default value is '-2': in that case the score is quadratic.

Message containing additional information about the result of the operation for the user.

The restrictions for the user relating mostly to usage of the core service. Given that almost every other API service uses the  core, this tends to affect usage in all services.

If true the user can set requests to ignore the cache when using the core service.

If true the user can toggle rush hour on/off when using the API services.

The maximum area (in m^2) of source geometries or exclusion geometries in requests to API services.

The maximum length (in m) of source geometries or exclusion geometries in requests to API services. This is the permiter  for polygons or just the length for lines.

The maximum complexity (total number of points) of source geometries or exclusion geometries in requests to API services.

The maximum number of active layers that can be used during routing calculations.

Maxmimum allowed value for the a Travel Time Factor.

Maximum allowed custom speed allowed for `bike` or `walk` travel modes.

Maximum sources allowed for reachability requests in the core service if the intersection mode is `AVERAGE`.

Maximum sources allowed for reachability requests in the core service if the intersection mode is `INTERSECTION`.

Maximum sources allowed for reachability requests in the core service if the intersection mode is `UNION`.

The maximum `edgeweight` (in meters) allowed when `edgeweight` is distance.

Maximum sources allowed for route requests in the core service.

Maximum targets allowed for route requests in the core service.

The maximum `edgeweight` (in seconds) allowed when `edgeweight` is time.

Maximum sources allowed for time requests in the core service.

Maximum targets allowed for time requests in the core service.

Minimum allowed value for the a Travel Time Factor.

Which intesection modes can be used for the polyogn service in the core API.

If the transportation mode is by bike, i.e. cycling.

bike

Define a geometry (Polygon/MultiPolygon) to clip the charts, multigraph and reachability responses.

This represents an (abstract) point on a map.

A description of the different connections

datasetId of the custom POI dataset you want to modify

Object with the different descriptions in the wanted languages

Wanted icon for the dataset/category. All available icons are available here: https://releases.targomo.com/tgm-icons/webfont/tgm-icon.html.
Only take the part after `tgm-`.

Object with the different names in the wanted languages

The description of the cause of the bad response

Description of the request errors that occurred which made the tour planning fail.

Object did not match the specified interface.

Developer?