at_home reports whether the device's most recent position resolves to one of the customer's registered locations. It is derived from the device's location on each measurement (not a raw GPS flag) and is exposed as a nullable boolean.
Latest value: GET /b2b/v1/businesses/{business_id}/devices/{dev_id}/metrics/latest → field at_home
History: GET .../devices/{dev_id}/metrics/at_home returns 1 (at home) / 0 (away) per timestamp.
| Value | Meaning | How it is determined |
|---|---|---|
true |
Device is at a registered location | The latest position is within ~300 m of a registered location; or no GPS position was shared but the customer has at least one registered location; or the registered location has no coordinates configured. |
false |
Device is away from all registered locations | The latest position is a real GPS fix that is more than ~300 m from every registered location — or the customer has no registered locations at all. |
omitted (null) |
Unknown — no recent data | No at_home reading exists in the last 24 hours: the device has never reported, has been offline/stale for over 24 h, or the integration is not yet delivering data. |
<aside> ⚠️
Do not treat null as "away." An omitted at_home means unknown (no recent telemetry), not false. Handle the three states — true, false, and absent — explicitly.
</aside>
true can be optimistic when GPS is withheld. Many OEMs do not share vehicle location (consent / privacy). For those vehicles, at_home defaults to true whenever the customer has any registered location — it is not proof the vehicle is physically home. false is the strong signal: it requires a real GPS fix that is far from all registered locations.true means "a registered location," not necessarily the primary home. A customer may have several (home, workplace, etc.). Use the location_id field in the same response to identify which one.true whenever they have recent data.Related fields: location_id, location_aware.