Links

Tracking (BETA)

Tracking is a process of identifying the location of a mobile phone whether stationary or moving. Our solution includes collecting latitude and longitude coordinates from GPS satellites through the GPS chip present in smartphones with iOS or Android operating systems. Along with the geographical coordinates, we collect a number of other supporting data points.

Location Updates

Location Updates are the GPS Coordinates that are collected along with other data points that aid with the quality of the tracking. A location update is defined by Roam as a collection of the following data points.
Attributes
Example
Description
tracking_mode
"active"
Roam's tracking mode (active, balanced, passive or custom) that was set in the SDK when the location was collected
coordinates
77.61679076999997, 12.900112149999995
Longitude, Latitude
speed
5
Speed in kilometers per hour (only during "moving" activity)
altitude
892.7507934570312
Height above the sea level in meters
course
-1
Direction heading in relation to north
horizontal_accuracy
17.071232461095033
Horizontal accuracy of the coordinates
vertical_accuracy
20.604103088378906
Vertical accuracy of the coordinates
activity
"moving"
Whether the location update was recorded when the user was "moving" or "stationary"
app_context
"foreground"
Wether the app was open or in the background while the location was recorded at. App States are "foreground", "background" or "terminated"
tz_offset
"+0530"
Timezone where the location was recorded
battery_status
"unplugged"
Wheter the phone was "charging" or "unplugged" when the location was recorded
battery_remaining
51
Remaining battery in percentage of device
battery_saver
false
Is battery saver mode enabled on the device
network_status
true
Wheter internet connection is enabled or not
location_permission
true
Wheter location permission is enabled or not
id
"62f2dbd90000c6975aa8f09a"
Unique indentified for the location update
created_at
"2022-08-09T22:12:41.586"
Timestamp of the location update registered in the roam backend database at in UTC (Coordinated Universal Time)
recorded_at
"2022-08-09T22:12:45.796"
Timestamp of the location update recorded by the device in UTC (Coordinated Universal Time)
Location updates collected by the SDK can be consumed in three ways, at the device level directly from the SDK, or using our webhooks for real-time data and the lat gets the historical data of a user using our GET location APIs.

SDK Listener

Webhooks

APIs

Last modified 15d ago