Each term below links to the page that defines it in full.
| Term | Meaning | Where it lives |
|---|---|---|
| config mode | How BeekonConfig is built. Local: your app owns the settings and nothing is uploaded. Custom: your app owns the settings and uploads to your own backend. Cloud: Beekon Cloud owns the settings and receives the uploads. Local and Custom together are self-managed mode. | Configuration |
| location | A reading the SDK admitted through the gate and stored. It is what the streams, uploads and the console show. | Locations & history |
| fix | The OS’s raw reading before the gate. Most fixes never become locations. | Raw passthrough |
| point | An older word for a stored location. It survives in a few API names, such as the path /v1/trips/{trip_id}/points and the member last_point_at. It means the same as location. | The location object |
| gate | The minimum-time and minimum-distance test every fix must pass to become a location. | The gate |
| gated | Flagged by Beekon Cloud’s own checks (low accuracy, implausible speed, mock location), which run on the server after the SDK’s gate. A gated location is stored with its reason, and reads skip it unless you ask. A fix the SDK’s gate turns away is never stored at all. | Admitted and gated locations |
| set aside | Refused by the server because the location’s time is outside the window the server accepts, usually a wrong device clock. A set-aside location is not stored as a location and can’t be read. | Ingest: response |
| session | One run of tracking between start() and stop(), kept across a relaunch. Every upload carries its session_id. | Root fields |
| segment | A run of locations in one upload that share one user id. | The upload payload |
| movement mode | How the device was moving when it recorded a location. The SDK’s activity, the Server API’s mode and the console’s Travel mode label are one concept: the server normalises activity into mode. | Location mode |
device / install_id | One app install. install_id is its stable, opaque id. | Devices |
user / user_id | The id your app sets with setUserId(...). It is bound to each location when it is recorded. See Choosing a user id. | Users |
| monthly active users (MAU) | The billing unit: distinct user ids, or devices with none, that sent a location in a calendar month (UTC). | Usage and the MAU cap |
| organisation | The account that owns projects and has members. | Organisation |
| member / role | A person in an organisation. Their role (owner, admin or member) decides what they can do in the console. | Roles |
| project | The Beekon Cloud unit your SDK key and server keys belong to. An organisation holds one or more projects, and each lives in one region. | Beekon Cloud |
| region | Where a project’s data lives. The Server API also calls it a cell, in key prefixes. | Base URL: one host per region |
| SDK key / server key | bkproj_… goes in the app; bkserv_… stays in your backend. | Authentication |
| remote config revision | The server-set number on the cloud-mode config document. Every real change produces a new revision, which devices pick up. | Remote config |
| geofence | A monitored area: a circle, or a polygon in Beekon Cloud. Crossing it records an enter or exit event. | Geofencing |
| trip | A stretch of one device’s locations between stops, cut on the server with no SDK change. | Trips |
| stalled trip | A trip with status stalled: its device has had no contact (any accepted SDK upload, heartbeats included) for trips.silence_timeout_seconds, or the server declared the device unreachable. New locations return it to open; otherwise it is closed later. The console’s Stalled status pill is a different thing, about the whole project. | The trip lifecycle |
| presence / reachable | Whether the server can still hear from a device. A device that goes quiet for too long becomes unreachable; its next contact makes it reachable again. | Device presence events |
| event | A record of something that happened in a project, such as a geofence enter or a trip end. Events are stored and can be read whether or not a webhook delivers them. | Events |
| webhook / endpoint | An HTTPS URL that receives a project’s events. The console calls it an endpoint; the Server API object is a webhook. They are the same thing. | Webhooks |
Choosing a user id
Section titled “Choosing a user id”Beekon Cloud stores the user id raw, exactly as your app sends it, and returns it in reads, events, exports and the console. Send an opaque, stable identifier such as your database key. Never send an email address or phone number.