Spatial Analysis

Find overlapping features

Returns intersection geometries between the input geometry/address and table features, including overlap area/length and overlap percentages against both input and target geometries. Supports custom output attribute names, units of measure, optional buffer distance, and pagination.

post/v1/spatial/overlap

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/spatial/overlap
  • Auth: one of:
    • bearerAuth (a scheme the document does not define)
    • ApiKeyAuth (a scheme the document does not define)

Query parameters

offsetinteger

Specifies the number of records to skip.

limitinteger

Specifies the maximum number of results to return.

Headers

X-Request-Idstring

The X-Request-Id header is optional but helpful for tracking requests. It acts as a unique identifier for troubleshooting and debugging issues effectively. Maximum length: 38 characters.Example: e02f00d5-e3a9-4fd6-aen1-3e5451abee46

Request body

tableNamestring required

Name of the table containing spatial data used by the operation.

attributeFilterstring

Optional scalar attribute filter expression using logical operators (AND/OR/NOT) and comparison operators such as =, <>, <, <=, >, >=, IS NULL, LIKE, BETWEEN, and IN.

attributesstring[] required

List of table attributes to include in the response. Use ["*"] to return all scalar table attributes.

uomstring required

Unit of measure used for overlap length/area output. Allowed units: mi, km, ft, m, nm.

areaAttributeNamestring

Custom name of intersection area parameter when intersection area is polygon. Default value is "intersectionArea".

lengthAttributeNamestring

Custom name of intersection length parameter when intersection area is linestring. Default value is "intersectionLength".

percentTargetAttributeNamestring

Custom name of parameter indicating percentage of overlap with target geometry. Default value is "percentageOfTarget".

percentInputAttributeNamestring

Custom name of parameter indicating percentage of overlap with input geometry. Default value is "percentageOfInput".

uomAttributeNamestring

Custom name of unit-of-measure attribute in the response. Default value is "uom".

bufferDistancestring

Distance by which the input geometry will be expanded. Supports positive values for all geometry types. Negative values are only supported for polygon geometries to create inward buffers.

Example request

{
  "tableName": "/risks/flood_risk",
  "location": {
    "format": "wkt",
    "value": "\"geometry\": \"POLYGON(((-96.8,30.5),(-97.7,30.5),\n(-97.7,29.9),(-96.8,29.9),(-96.8,30.5)))\"",
    "country": "USA"
  },
  "attributeFilter": "rms_err < 50",
  "attributes": [
    "id",
    "name",
    "location"
  ],
  "uom": "m",
  "areaAttributeName": "overlappedArea",
  "lengthAttributeName": "overlappedLength",
  "percentTargetAttributeName": "targetOverlapPercent",
  "percentInputAttributeName": "inputOverlapPercent",
  "uomAttributeName": "measurementUnit",
  "bufferDistance": "\"100 m\""
}

Response

Successful retrieval of overlaps operations

Changes

No recorded changes to this operation across all 1 revision of this API.