Skip to main content

TestPointResponse

Schema for test point response.

Provides both the legacy results array (unchanged for backward compatibility) and the new matched_geofences array with enhanced group information.

point objectrequired
property name*any
inside_geofencesInside Geofences (integer)required
total_geofencesTotal Geofences (integer)required
results object[]required
  • Array [
    • geofence_idGeofence Id (string)required
    geofence_nameGeofence Name (string)required
    is_insideIs Inside (boolean)required
    distance_meters object
    anyOf
    number
  • ]
    • matched_geofences object[]

    Geofences containing the test point, with group info. Ordered by distance_meters ASC, then geofence_id ASC.

  • Array [
    • geofence_idGeofence Id (string)required
    geofence_nameGeofence Name (string)required
    group_id object
    anyOf
    string
    group_name object
    anyOf
    string
    distance_meters object

    Distance from point to geofence edge in meters (0 if inside)

    anyOf
    number
  • ]
    • request_metadata object

    Client data echoed back unchanged from request.

    anyOf
    object
    TestPointResponse
    {
      "point": {},
      "inside_geofences": 0,
      "total_geofences": 0,
      "results": [
        {
          "geofence_id": "string",
          "geofence_name": "string",
          "is_inside": true,
          "distance_meters": 0
        }
      ],
      "matched_geofences": [
        {
          "geofence_id": "string",
          "geofence_name": "string",
          "group_id": "string",
          "group_name": "string",
          "distance_meters": 0
        }
      ],
      "request_metadata": {}
    }