Overview

Fetch a list of the locations with Geofences

  • Endpoint: v1/geofences
  • Description: Retrieves a list of all locations where geofences have been established. Each geofence defines a specific area that can trigger alerts or actions when vehicles or assets enter or exit.
  • Use Case: Fleet Managers use Geofences to determine if the vehicle has reached its designated location or not. It also allows the to monitor key zones such as depots, customer sites, and others.

Fetch a Geofence information using its ID

  • Endpoint: v1/geofences/{id}
  • Description: Retrieves detailed information about a specific geofence, such as its boundaries, associated alerts, and assigned assets.
  • Use Case: Useful for fleet managers or admins who need to view or verify details about a specific geofence to ensure it’s set up correctly for operational requirements.

Create a new Geofence (Polygon)

  • Endpoint: v1/geofences
  • Description: Creates a new polygon-shaped geofence by specifying multiple boundary points,
  • Use Case: This endpoint is ideal for creating geofences that match irregularly shaped areas like custom facilities, city blocks, or any non-circular region where monitoring entry/exit is critical.

Create a new Geofence (Circular)

  • Endpoint: v1/geofences/circular
  • Description: Sets up a circular geofence by specifying a center point and radius, creating a simple and quick-to-define geofenced area.
  • Use Case: Useful for geofencing circular areas such as gas stations, parking lots, or specific points of interest where it’s important to track asset entry and exit.

Update an existing Geofence

  • Endpoint: v1/geofences/{id}
  • Description: Modifies an existing geofence with info such as location points, status, category and others.
  • Use Case: Fleet Managers can make some important updates to an existing geofence by using this endpoint.

Delete a Geofence

  • Endpoint: v1/geofences/{id}
  • Description: Removes a specific geofence from the system, disabling any tracking or alerts associated with it.
  • Use Case: When a location no longer needs monitoring, deleting the geofence helps avoid unnecessary alerts and keeps the geofence list organized.

Fetch a list of all the Geofence events

  • Endpoint: v1/geofences/events
  • Description: Retrieves a record of all geofence-related events,
  • Use Case: This endpoint helps fleet managers review geofence activity history, monitor entry/exit patterns, and ensure assets are staying within designated areas.

Fetch a list of all the company asset Geofence events

  • Endpoint: v1/geofences/asset_events
  • Description: Fetches geofence events specifically related to company assets, such as vehicles or equipment crossing geofence boundaries.
  • Use Case: Useful for auditing asset activity, identifying any unexpected geofence crossings, and ensuring asset movements align with company policies.