Overview

Predefined locations can be queried in any of the data endpoints (/timeline, /route), however, they are mainly used by Monitors.

Locations linked to an Alert will be constantly monitored to check whether or not the Insight conditions are forecasted to be truthy. In such a case, an Event will be created, and Notifications will be triggered out to the webhook defined for the account, as configured (prior/start/end).

Note:
For GeoJSON use [lon, lat]
For Query Parameters use [lat, lon]

Point Geometry

A point location is defined by geometry object, according to the [GeoJSON format]( GeoJSON format), whereas the type is "Point" and a single pair of longlat coordinates array.
In case a point has been queried for fields with a Max/Min/Avg suffix, the field values will default to the actual conditions at that point. The point location query parameters are passed as [latitude, longitude].

{
  "type": "Point",
  "coordinates": [125.6, 10.1]
}

Polygon Geometry

A polygon location is defined by geometry object, according to the GeoJSON format, whereas the type is "Polygon" and an array of longlat pairs coordinates.

In case a polygon has been queried for fields with a Max/Min/Avg suffix, the field values will be calculated accordingly throughout the covered area. Otherwise, polygon field queries will default to Max (as if the suffix was added).

{
  "type": "Polygon",
    "coordinates": [
      [
      [100.0, 0.0],
      [101.0, 0.0],
      [101.0, 1.0],
      [100.0, 1.0],
      [100.0, 0.0]
      ]
    ]
}

Polyline Geometry

A polyline location is defined by geometry object, according to the GeoJSON format, whereas the type is "LineString" and an array of longlat pairs coordinates.

In case a polyline has been queried for fields with a Max/Min/Avg suffix, the field values will be calculated accordingly throughout the polyline. Otherwise, polyline field queries will default to Max (as if the suffix was added).

{
    "type": "LineString",
    "coordinates": [[-100, 40], [-105, 45], [-110, 55]]
}