Roam.ai Docs
HomeContactDashboard
  • Introduction
  • Getting Started
    • Key Concepts
  • Frameworks
  • Android
    • Quickstart (Android)
    • Pub/Sub Locations (Android)
    • SDK Methods (Android)
      • SDK Configuration (Android)
      • Get Current Location (Android)
      • Update Current Location (Android)
      • Update Location When Stationary (Android)
      • Trip v1 SDK Methods (Android)
      • Trip v2 SDK Methods (Android)
        • Create Trip (Android)
        • Update Trip (Android)
        • Start Quick Trip (Android)
        • Start Trip (Android)
        • End Trip (Android)
        • Pause Trip (Android)
        • Resume Trip (Android)
        • Sync Trip (Android)
        • Get Trip (Android)
        • Get Active Trips (Android)
        • Get Trip Summary (Android)
        • Subscribe to Trip (Android)
        • Delete Trip (Android)
    • Utility Methods (Android)
    • Troubleshooting (Android)
    • Changelog (Android)
  • iOS
    • Quickstart (iOS)
    • Pub/Sub Locations (iOS)
    • SDK Methods (iOS)
      • SDK Configuration (iOS)
      • Get Current Location (iOS)
      • Update Current Location (iOS)
      • Update Location When Stationary (iOS)
      • Trips v1 SDK Methods (iOS)
      • Trips v2 SDK Methods (iOS)
        • Create Trip (iOS)
        • Update Trip (iOS)
        • Start Quick Trip (iOS)
        • Start Trip (iOS)
        • End Trip (iOS)
        • Pause Trip (iOS)
        • Resume Trip (iOS)
        • Sync Trip (iOS)
        • Get Trip (iOS)
        • Get Active Trips (iOS)
        • Get Trip Summary (iOS)
        • Subscribe Trip (iOS)
        • Delete Trip (iOS)
    • Utility Methods (iOS)
    • Troubleshooting (iOS)
    • Changelog (iOS)
  • React Native
  • Flutter
  • PRODUCTS
  • Tracking (BETA)
  • Geofencing
  • Trips
  • APIs
    • Authorization
    • Users API
      • Create User API
      • Get User API
      • Update User API
    • Locations API
      • Get Locations API
      • Get Stop Locations API
    • Insights API
      • Get User POIs API
      • Get User Home Location API
      • Get User Work Location API
    • Trips v1 API
      • Create Trip API v1
      • Get Trip API
      • Update Trip API v1
      • Delete Trip API v1
      • Trip Summary API
      • Export Trip Summary as GPX
    • Trips v2 API
      • Create Trip API
      • Get Single Trip API
      • Get Multiple Trips API
      • Update Trip API
      • Control Trip API
        • Start Trip API
        • Pause Trip API
        • Resume Trip API
        • End Trip API
      • Get Trip Summary API
      • Export Trip API
      • Delete Trip API
    • Geofencing API
      • CREATE Geofence API
      • GET Geofence API
      • UPDATE Geofence API
      • DELETE Geofence API
    • Events API
      • Get Events
      • Trip Events
    • Nearby API
      • Get Nearby User API
      • Get Nearby Geofence API
    • Moving Geofence API
      • Create Moving-Geofence API
      • Update Moving-Geofence API
      • GET Moving-Geofence API
      • Delete Moving-Geofence API
    • User Groups API
      • Create Group API
      • Get User Group by ID
      • Get User Group List
      • Add Users to Group API
      • Update Group API
      • Find Nearby Users from Group
    • Query with Metadata
  • WEBHOOK
    • Webhook
    • Slack Integration
  • LIBRARIES
    • Javascript Library
    • Go Library
    • Python Library
Powered by GitBook
On this page

Was this helpful?

Export as PDF

Tracking (BETA)

In progress...

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

PreviousChangelog (iOS)NextGeofencing

Last updated 2 years ago

Was this helpful?