Web APIAnalytics
Analytics
Aggregated views over pings, devices and geofences — activity, density, occupancy, dwell time and processing latency.
https://api.locantra.deSummarise how recently assets were seen
https://api.locantra.de/analytics/assets/currentCounts the transponders of your organisation seen in the window by how recently they last reported: within five minutes, fifteen minutes, an hour, a day, and the ones stale beyond that or last seen without a usable position. From and To bound the window and default to the last 24 hours; it may not span more than 31 days. GroupBy splits the result into one row per value of that dimension, returned as Group; without it the result is a single ungrouped series. OrderCategory, OrderTag, AssignmentCategory and AssignmentTag narrow the result to the orders or transponder assignments carrying those organisation-defined classifications, and order_category, order_tag, assignment_category and assignment_tag break it down by them; a classification breakdown covers only the orders or assignments that carry one, and an entity with several tags is counted in each of its tag groups.
Snapshot the fleet's health
https://api.locantra.de/analytics/devices/healthRolls up the latest status of every device of your organisation: how many are online, and how many report a low battery, a high temperature, a weak signal or an error. The thresholds those counts use are yours to set. This is a snapshot of the present, not a window. Set IncludeDevices to add the per-device rows, which are paged with Limit (default 100, maximum 1000) and Offset; the response envelope's Page then carries the applied Limit and the Total device count, while Summary always covers the whole fleet.
Count what is currently inside each geofence
https://api.locantra.de/analytics/geofences/occupancyReports, per geofence of your organisation, how many transponders are inside it right now and how many orders they belong to. Occupancy is read from each transponder's last ping, so a transponder that stopped reporting stays where it was last seen, and one currently outside every geofence is not counted. This is a snapshot of the present, not a window. Results are paged with Limit (default 100, maximum 1000) and Offset; the response envelope's Page carries the applied Limit and the Total geofence count.
Summarise geofence crossings and dwell times
https://api.locantra.de/analytics/geofences/summaryCounts the geofence entries and exits of your organisation in the window, with how many transponders and orders crossed and how long they stayed. TransponderID filters by the chip codes printed on the transponders, not by assignment IDs, and Edge narrows the result to one crossing direction. From and To bound the window and default to the last 24 hours; it may not span more than 31 days. GroupBy splits the result into one row per value of that dimension, returned as Group; without it the result is a single ungrouped series. This operation groups by geofence, device or order, or by an order classification, only. OrderCategory and OrderTag narrow the result to the orders carrying those organisation-defined classifications, and order_category / order_tag break it down by them; the transitions carry no transponder assignment, so the assignment classifications are not available here. The result is bounded by the window and its buckets rather than paged.
Report ping activity per hour
https://api.locantra.de/analytics/pings/activityReports how many pings your organisation recorded per hour, with how many transponders, orders and devices were behind them and how many pings fell inside a geofence or carried no usable position. From and To bound the window and default to the last 24 hours; it may not span more than 31 days. GroupBy splits the result into one row per value of that dimension, returned as Group; without it the result is a single ungrouped series. OrderCategory, OrderTag, AssignmentCategory and AssignmentTag narrow the result to the orders or transponder assignments carrying those organisation-defined classifications, and order_category, order_tag, assignment_category and assignment_tag break it down by them; a classification breakdown covers only the orders or assignments that carry one, and an entity with several tags is counted in each of its tag groups. The result is bounded by the window and its buckets rather than paged.
Map ping density onto geo cells
https://api.locantra.de/analytics/pings/densityCounts the processed pings of your organisation per geo cell, for a heat map. Cell picks the index — geohash, h3 or s2 — and Precision the geohash prefix length. From and To bound the window and default to the last 24 hours; unlike the other analytics operations it may not span more than 7 days. The result is bounded by the window and its buckets rather than paged.
Report ping processing latency per hour
https://api.locantra.de/analytics/pings/processingReports how long the platform took to process your organisation's pings per hour, as the median, 90th and 99th percentile of both the processing itself and the whole path from receiving a ping to finishing it. From and To bound the window and default to the last 24 hours; it may not span more than 31 days. GroupBy splits the result into one row per value of that dimension, returned as Group; without it the result is a single ungrouped series. OrderCategory, OrderTag, AssignmentCategory and AssignmentTag narrow the result to the orders or transponder assignments carrying those organisation-defined classifications, and order_category, order_tag, assignment_category and assignment_tag break it down by them; a classification breakdown covers only the orders or assignments that carry one, and an entity with several tags is counted in each of its tag groups. The result is bounded by the window and its buckets rather than paged.