Get Geofence Events

get

https://talk.perspio.io/geofences/v3/{id}/events

Returns geofence entry/exit events for the geofence, within an optional time range and severity filter. When page_size is supplied the response is paged and the ContinuationToken, ResultCount and TotalCount values are returned as response headers; pass the ContinuationToken back via the token query parameter (or the ContinuationToken request header) to fetch the next page. Results are scoped to the assets the caller is permitted to see.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Geofence Id

Query Params

from

date-time

Start of the event time range (ISO 8601, UTC). When omitted the service default window applies.

date-time

End of the event time range (ISO 8601, UTC).

severityTypes

array of strings

Filter to specific event severities. Repeat the parameter or comma-separate values. When omitted, all severities are returned.

severityTypes

daterange

string

Named date range shortcut (alternative to from/to), evaluated in the supplied timezone.

timezone

string

IANA timezone used to evaluate daterange. Defaults to UTC.

page_size

integer

Maximum number of events per page. When greater than 0 the response is PAGED and returns the ContinuationToken, ResultCount and TotalCount response headers; when omitted or 0 all matching events are returned in a single unpaged response.

token

string

Continuation token used to fetch the next page. Pass the value of the ContinuationToken response header from the previous call. May also be supplied via the ContinuationToken request header.

Headers

includedisabledassets

boolean

When true, disabled assets are included in the asset scope used to resolve the caller’s data permissions for this request. Defaults to false.

ContinuationToken

string

Continuation token to fetch the next page, taken from the previous response's ContinuationToken header. Equivalent to the token query parameter.

Responses

401

Invalid API Key provided or Invalid Access token

403

Forbidden. The caller is not permitted to access the requested tenant or geofence, or lacks the required role.

404

Resource Not Found

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Invalid Request

500Internal Server Error