Web APIPermissions
Permissions
What each Web API key permission grants.
anchors.manage
Create, update, and delete organisation anchor tags.
anchors.read
Read organisation anchor tags.
assignments.manage
Create, update, end, and delete assignments.
assignments.read
Read transponder and order assignments.
buildings.manage
Create, update, and delete buildings, floors, and floor plans.
- POST
/buildingCreate a building - PATCH
/buildingUpdate a building - DELETE
/buildingDelete a building - POST
/building/floorCreate a building floor - PATCH
/building/floorRename a building floor - DELETE
/building/floorDelete a building floor - POST
/building/floorplanUpload a floor plan - PATCH
/building/floorplanUpdate a floor plan - DELETE
/building/floorplanDelete a floor plan
buildings.read
Read buildings, floors, and floor-plan metadata.
devices.path.read
Read device path and position data.
devices.position_overwrites.manage
Create, update, and delete device position overwrite data.
devices.read
Read organisation devices.
devices.status.read
Read device status data.
geofences.manage
Create, update, and delete geofences.
geofences.read
Read geofences and geofence-derived ping data.
- GET
/analytics/geofences/summarySummarise geofence crossings and dwell times - GET
/geofenceGet one geofence - GET
/geofence/eventsList geofence enter and exit events - GET
/geofence/latest/pingsGet the latest position per transponder inside a geofence - GET
/geofence/pingsGet the positions recorded inside a geofence - GET
/geofencesList geofences
livepings.read
Subscribe to live raw or processed ping streams.
orders.manage
Create, update, and delete orders.
orders.read
Read orders and order-derived tracking data.
- GET
/orderGet one order - GET
/order/pathGet the recorded path of an order's transponders - GET
/order/pings/latestGet the latest position of every transponder on an order - GET
/order/positionGet the latest position of one transponder assignment - GET
/order/summaryGet an order with its transponder assignments - GET
/ordersList orders - GET
/orders/activityList orders with their tracking activity
pings.read
Read ping aggregates and enriched ping data.
- GET
/analytics/assets/currentSummarise how recently assets were seen - GET
/analytics/geofences/occupancyCount what is currently inside each geofence - GET
/analytics/pings/activityReport ping activity per hour - GET
/analytics/pings/densityMap ping density onto geo cells - GET
/analytics/pings/processingReport ping processing latency per hour
transponders.manage
Create, update, and end transponder assignments.
transponders.read
Read transponders and transponder tracking data.