[beta] Look up geofence suggestions

get

https://api.samsara.com/places/geofence

Returns geofence suggestion candidates for a seed point. Does not create or update a Place. Applies the same selection rules as geofence.auto on Place write.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Places under the Places category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

latitude

double

required

Seed point latitude in WGS84 decimal degrees.

longitude

double

required

Seed point longitude in WGS84 decimal degrees.

suggestionTypes

string

Comma-separated geofence suggestion types in priority order. Values: building, parcel, landUse, boundary, facility, infrastructure.

sizeOrder

string

enum

Candidate sort order: smallestFirst (default) or largestFirst. Valid values: smallestFirst, largestFirst

Allowed:

minLatitude

double

Search bound minimum latitude (WGS84 decimal degrees). Must be supplied with minLongitude, maxLatitude, and maxLongitude, or omitted entirely.

minLongitude

double

Search bound minimum longitude (WGS84 decimal degrees).

maxLatitude

double

Search bound maximum latitude (WGS84 decimal degrees).

maxLongitude

double

Search bound maximum longitude (WGS84 decimal degrees).

maxAreaSquareMeters

double

Drop candidates with area above this value in square meters.

maxSourceVertices

int64

Drop candidates whose source polygon exceeds this vertex count before simplification.

maxVertices

int64

Simplify each returned candidate polygon to at most this many vertices.

maxResults

integer

1 to 20

Defaults to 5

Page size: max candidates in data[] per page. Default 5, max 20.

after

string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Responses

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.