Telematics SDK | Developer portal
  • Get started
  • 4 Steps to Integrate SDK
  • Product Wiki
  • License
  • FAQ
  • PRODUCT DESCRIPTION
    • How it works
    • SDK Features
    • Scoring
      • Risk driving Scoring
        • Event detection
        • Trip rating
        • Overall scoring
      • Eco Scoring
    • Dataset
      • Dataset | User statistics API
      • Data samples
        • Summary - Processed track details (Rich track details)
        • Processed track waypoints (Rich track points)
        • Summary - list of Processed tracks
        • Incoming track events
        • Incoming track points (waypoints)
        • Summary - list of Incoming tracks
      • Dataset Decription
        • Bluetooth OBD - Vehicle Dataset
        • LastKnownPoints
        • IncomingTrackPoints
        • IncomingTrackEvents
        • Enriched telematics data
          • RichTracks
          • RichTrackPoints
          • RichTrackEvents
          • RichTrackDetails
          • UserStatisticDrivingDetails
        • Raw telematics data from SDK
    • Reporting
      • Drivecoins summary
      • Trip summary
      • Scoring summary
      • User state
      • Fraud
      • Trip waypoints
      • Trip events
    • External Articles
      • Why mobile telematics hits hardware telematics
  • Step 1: Create Datahub Account
  • Step 2: SDK Installation
    • Get started
    • iOS SDK installation
      • *Set up Your Development Environment
      • *Configure Your Project
      • *App Delegate
      • *Configure Framework
      • *React Native Installation
        • Create the iOS bridge
      • Add list of trips to your ViewController
      • Add statistics data to your ViewController
      • *What’s different in iOS 13?
      • *iOS 13 Permissions Wizard
      • *SDK Enable \ Disable \ Disable With Upload
      • *Incoming Tags
      • *Tracking Status
      • *SDK Delegates
      • *SDK Modes
      • *Using the Debugging Tools in Simulator
    • Android SDK installation
      • *Getting started
        • *Set up Your Development Environment
        • *Setup and enable SDK
        • *Permissions wizard
        • *Permissions dialog
        • *Configure SDK variables for notifications
      • *Subscribe to tracking events
      • *Incoming tags managing
      • *Migration from SDK v1.6.x to SDK v2.0.x
    • *Check SDK Installation
      • iOS Simulator
      • DataTool
      • ZenRoad
    • *Demo Applications
      • iOS | Open Source Demo Application
      • iOS | SDK Demo Application
      • iOS | Swift | SDK Demo Application
      • Android | SDK Demo Application
      • Android | Java | SDK Demo Application
      • Flutter | SDK Demo Application
    • SDK Changelog
      • Android SDK Changelog
      • iOS SDK Changelog
    • Permissions Guides
      • First Launch
        • iOS 13 (and higher) Permissions Guide
        • iOS 12 (and lower) Permissions Guide
        • Android 9 Permissions Guide
        • Android 9 XIaomi Permissions Guide
        • Android 10 Permissions Guide
      • *Troubleshooting
        • iOS — Troubleshooting
          • iOS — Troubleshooting
        • Android — Troubleshooting
          • Samsung — Troubleshooting
          • Oppo — Troubleshooting
          • Huawei — Troubleshooting
          • Xiaomi — Troubleshotting
          • OnePlus — Troubleshooting
          • Meizu — Troubleshooting
          • Asus — Troubleshooting
          • Vivo — Troubleshooting
          • Wiko — Troubleshooting
  • Step 3: Register SDK users
    • User Registration (API)
  • Step 4: API | User Statistics, Scores, Trips
    • Step 4: Get Statistics, Scorings and Trip Data
    • API Authorization
    • Statistics and Scoring APIs
      • Get started - Statistics and Scoring API
      • User | Individual Scorings and Statistics
      • Admin | User(s) - Scorings and Statistics
      • Admin | Consolidated Scorings and Statistics
    • Trips API
      • Get a short list of tracks
      • Get a list of tracks with paging
      • Get a list of tracks by IDs
      • Get a single track with waypoints
      • Get the most earliest track
      • Track Statuses
  • SDK Features
    • *Bluetooth Device - Get started
      • *Get Started
      • *Android - ELM API
      • *iOS - ELM API
    • Trip Tags - Get started
      • Tags for trips via mobile app
        • Android - Tags for trips
        • iOS - Tags for trips
      • Tags for period
      • Trip log by tags
  • PLATFORM FEATURES
    • *User Management
      • *User Registration
      • *Check User Existence
      • *User Management
    • *Vehicle Management
      • *Directories
      • *Vehicles
    • FNOL, Inspections & Damage Recognition
      • Get started
      • Profiles
      • Claims
      • Vehicle inspections
        • Dictionary of vehicle photos
      • Photo processing
    • *Leaderboard
      • *Summary Leaderboard
      • *Leaderboard by factors
      • Swagger - Leaderboard
    • *Streaks
    • *SNS
      • *How to register AWS SNS
    • 3rd party data processing
      • Swagger - Incoming getaway
    • *User & Permissions Status | Heartbeats
  • Other
    • Response Codes
    • Resources swaggers
      • Swagger: User service
      • Swagger: Scorings and Statistics API
      • Swagger: Telematics data
      • Swagger: Leaderboard
      • Swagger: Vehicle Management
      • Driving details
      • Swagger: FNOL, Inspections & Damage Recognition
      • Swagger: Heartbeats
    • Archive
      • Get started
      • Statistics and Scorings API
      • Step 5: Get statistics and trip data [ARCHIVED]
      • User Statistics API [Archived]
      • SDK - Statistics API [ARCHIVED]
        • Get the data to the Android app
          • Android Telematics data (Tracks)
            • Check current running track state
            • Get start date for current recording trip
            • Register tracking state listener (for onStartTracking/onStopTracking events)
            • Register speed violations listener
            • Get flag for registered speed violations listener
            • Get registered speed limit in km/h or default
            • Get registered speed violations timeout in ms or default
            • Get Tracks
            • Get detailed trips information
            • Get available user roles
            • Change a user role (any of TrackOriginDictionary.code)
          • Android User Statistics
            • Get Dashboard info
            • Get detailed Dashboard
            • Get Driving time statistics
            • Get Speeding statistics
            • Get Mileage statistics
            • Get Distracted Phone Usage statistics
        • Get the data to the iOS app
          • Other methods
          • iOS Telematics data (tracks)
            • Request all Tracks with specified offset and limit
            • Request all Tracks with specified offset and limit. No filter will be used in request
            • Request Track info with specified Track Token
            • Request Track origins dictionary
            • Change Track Origin Code
            • Share Track
          • iOS User Statistics
            • Get shared Track
            • Request main statistics data for all possible statistic types
            • NS_ENUM
            • Request main statistics data for all possible statistic types
            • Properties and Protocols
      • Get all DeviceTokens
    • Report a bug
    • Data Hub
    • Talk to sales
  • Postman collection
Powered by GitBook
On this page
  • Get the latest heartbeat for an individual user
  • Get the latest heartbeats for a list of users
  • Fields dictionary

Was this helpful?

  1. PLATFORM FEATURES

*User & Permissions Status | Heartbeats

Previous3rd party data processingNextResponse Codes

Last updated 4 years ago

Was this helpful?

Heartbeats - system information that we receive from SDK in background. Average period of heartbeats is around 2 hours, but it also depends on a stability of user's internet connection.

Heartbeats help to indicate if the user has an installed application with active SDK and also shows other system information such as statuses of granted permissions, device model, OS version, etc.

NOTE: all the API methods below will be replaced with new ones before 31.03.2021

Get the latest heartbeat for an individual user

GET https://mobilesdk.telematicssdk.com/api/heartbeats/get/v{version}/raw/users/{userId}/latest

Authorization: Required as Admin with API Authorization Credentials

Query Parameters

Name
Type
Description

Version

string

Value "1" is required here

userID

string

User's deviceToken

{
    "Result": {
        "UserId": "736cbd83-a937-4889-ae79-af2d5b63d63d",
        "Heartbeat Date": "2020-12-03T06:24:14.9145253",
        "WiFi Enabled": true,
        "GPS Enabled": true,
        "Mobile Data Enabled": false,
        "Latitude": 43.4650551,
        "Longitude": 40.9211685,
        "Extended Data": {
            "Application": "v1.5.4.20201230.0001 (com.raxel.coreproduct)",
            "Device Has Been Rooted (Android)": "0",
            "Device Model": "iPhone8,4",
            "Device OS Version": "iOS 14.0.1",
            "GPS Permission Granted": "Always",
            "JailBreak (iOS)": "0",
            "Low Power Mode": "false",
            "Low Precise Location (iOS)": "false",
            "Motion & Fitness Permission Granted (iOS)": "YES",
            "Motion Activity Permission Granted (Android)": "false",
            "SDK Version": "RPSDK v5.9.0.204 - 2020-11-30T13:52:27+0300"
        }
    },
    "Status": 200,
    "Title": "",
    "Errors": []
}

Get the latest heartbeats for a list of users

POST https://mobilesdk.telematicssdk.com/api/heartbeats/get/v{version}/raw/users/latest

Authorization: Required as Admin with API Authorization Credentials Note: maximum list size is 20 tokens.

Query Parameters

Name
Type
Description

Version

string

value "1" is required here

{
"Result": [
        {
        "UserId": "736cbd83-a937-4889-ae79-af2d5b63d63d",
        "Heartbeat Date": "2020-12-03T06:24:14.9145253",
        "WiFi Enabled": true,
        "GPS Enabled": true,
        "Mobile Data Enabled": false,
        "Latitude": 43.4650551,
        "Longitude": 40.9211685,
        "Extended Data": {
            "Application": "v1.5.4.20201230.0001 (com.raxel.coreproduct)",
            "Device Has Been Rooted (Android)": "0",
            "Device Model": "iPhone8,4",
            "Device OS Version": "iOS 14.0.1",
            "GPS Permission Granted": "Always",
            "JailBreak (iOS)": "0",
            "Low Power Mode": "false",
            "Low Precise Location (iOS)": "false",
            "Motion & Fitness Permission Granted (iOS)": "YES",
            "Motion Activity Permission Granted (Android)": "false",
            "SDK Version": "RPSDK v5.9.0.204 - 2020-11-30T13:52:27+0300"
        }
    },
        {
        "UserId": "736cbd83-a937-4889-ae79-af2d5b63d63d",
        "Heartbeat Date": "2020-12-03T06:24:14.9145253",
        "WiFi Enabled": true,
        "GPS Enabled": true,
        "Mobile Data Enabled": false,
        "Latitude": 43.4650551,
        "Longitude": 40.9211685,
        "Extended Data": {
            "Application": "v1.5.4.20201230.0001 (com.raxel.coreproduct)",
            "Device Has Been Rooted (Android)": "0",
            "Device Model": "iPhone8,4",
            "Device OS Version": "iOS 14.0.1",
            "GPS Permission Granted": "Always",
            "JailBreak (iOS)": "0",
            "Low Power Mode": "false",
            "Low Precise Location (iOS)": "false",
            "Motion & Fitness Permission Granted (iOS)": "YES",
            "Motion Activity Permission Granted (Android)": "false",
            "SDK Version": "RPSDK v5.9.0.204 - 2020-11-30T13:52:27+0300"
        }
    }
],
    "Status": 200,
    "Title": "",
    "Errors": []
}
{
  "Users": [
    "3fa85f64-5717-4562-b3fc-2c963f66afb6", // user's deviceToken
    "3fa85f64-5717-4562-b3fc-2c963f66afb6"
  ]
}

UserID

User's deviceToken

Heartbeat Date

The date of the latest heartbeat

WiFi Enabled

true/false | Shows the status of WiFI sensor

GPS Enabled

true/false | Shows the status of GPS sensor

Mobile Data Enabled

true/false | Shows the status of mobile data

Latitude

Latest known latitude

Longitude

Latest known longitude

Application

Application

Device Has Been Rooted (Android)

0 = false, 1 = true | Shows if the Android device has been rooted.

Device Model

Device Model

Device OS Version

Device OS Version

GPS Permissions Granted

Shows the status of app permissions to GPS sensor

JailBreak (iOS)

0 = false, 1 = true | Shows if the iOS device has been hacked

Low Power Mode

true/false | Shows if the low power mode is active (tracking doesn't work stable, when lower power mode is active)

Low Precise location (iOS)

true/false | Shows if the Low Precise Location mode is active on iOS devices (tracking doesn't work, when the low precise location mode is active)

Motion & Fitness Permission Granted (iOS)

YES/NO | Shows the status of app permission for Motion & Fitness on iOS devices

Motion Activity Permission Granted (Android)

true/false | Shows the status of app permission for Motion Activity on Android devices

Fields dictionary

👇
API Authorization
DataTool