Geofencing API

Report service

Decommission notice

December 16, 2025

  • This service will be decommissioned on January 31, 2027.
  • All endpoints will be withdrawn following a 12 months deprecation period.
  • There is no recommended migration path.

Purpose

The Geofencing Report returns information about fences surrounding a provided point at the moment of the request.

The Geofencing API Report service provides a JSON document that contains the following information for a specified object or point:

  • A list of fences that the object/point is inside of.
  • A list of the fences within a specified radius that the object/point is not inside of.
  • The lists can be empty:
    • If no fences match the request parameters.
    • If there are no fences left in the project.

Report service endpoint

The Report service contains the following endpoint:

Report request

A short summary containing a unique project id, the position for which the report is generated, and a radius used to create the report expressed in meters.

Report request

Please use the navigation menu on the left-side of each page to find the topic and data you need.