The Datamotion Developer Hub

Welcome to the Datamotion developer hub. You'll find comprehensive guides and documentation to help you start working with our embedded services as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

UserDataHub

UserDataHub is the back-end configuration interface of our platform. It contains 3 main parts:

  • :point-right: Product management
  • a set of services to manage Telematics SDK, API services, and Platform
  • :point-right: DataTool
  • a workspace for developers to get full system information about the user device and SDK.
  • :point-right: Analytics portal
  • a set of workspaces to work with users, analytics, telematics data, and other API services.

Overview

User service credentials
The main link here, the part which contains credentials for SDK User registration

Company Settings
Basic Company information like Name, Country. You are also able to delete company here.

Company Products
Products that are enabled for your Company. (Telematics SDK is enabled by default.)

Access management
Invite your partners and co-workers to UserDataHub to work with driver analytics. Note, that you can invite them across different levels.
:point-right: Read more

Application Settings

SDK Installation
A link to this developer portal.

DataTool

  • a workspace for developers to get full system information about the user device and SDK.
    :point-right: Learn more

Group settings
Page to manage basic group settings like name and description. Also, you can delete a user group from this page.
:point-right: Learn more about User Groups

Realtime data
The feature enables real-time data collection. This service allows you to use telematics SDK as a location tracker and use it with any 3rd party fleet management platform.
:point-right: Learn more

Schedule
Manage a schedule and apply rules when SDK has to track drivers, i.e. you can set working hours from 9 am to 6 pm and SDK will track activities only during working hours.
:point-right: Read more

API Authorization credentials
Create admin credentials to build back-end integrations and manage users and services.
:point-right: Platform Layout and Authentication


User service credentials

The part provides InstanceID and InstanceKEY for a particular group of users. Each group has a unique combination of InstanceID and InstanceKey. These details are required to interact with user-service and create users in order to use Telematics SDK
:point-right: Platform Layout and Authentication

Realtime data

  • Enable/Disable real-time data
  • Manage IMEI
  • Point data to 3rd party fleet management platform :point-right: Read more
  • Manage settings for frequency of data collection and transmission

Manage schedule

  • Enable/Disable schedule
  • Create time-slot(s) when SDK has to track activities

Access management

You can provide different levels of access to UserDataHub for your partners and co-workers. Access management is available across the following levels:

  • Company level
  • Application level
  • User Group level

Users can be invited either via a link or email invitation.

API Authorization Credentials

These credentials are required to have admin access to the services.

📘

Admin account has its own Instance ID

:point-right: *Authentication and access

Amazon AWS S3 Data Export

You can set up automatic daily export of pre-built reports to your own Amazon S3 Bucket. More details

Back-end Notification (Amazon AWS SNS / Microsoft Azure)

You can set up automatic back-end notifications for different levels of data processing, including raw data.


DataTool

Overview

The workspace contains 5 main parts:

User details

Basic information about SDK user, including deviceToken, personal fields and User Group, where the user was registered.

User status (SDK, Devices)

This part contains important information about the status of each stage in data management workflow as well as SDK Status.

Heartbeats

Heartbeats - system information that we receive from SDK in background. Average period of heartbeats is around 2 hours, but it also depends on the stability of a user internet connection.
Heartbeats are used to deliver settings from Datamotion server to SDK and also to get Telematics SDK status, including Permissions status, device information, and OS version.

Field

Short description

Trips on device

A number of not uploaded trips.
To optimize battery consumption, telematics SDK sends data only while certain level of internet connection. In case of lack of Internet or unstable level of the Internet, SDK stores trip data until it can be sent without impact on a phone battery. Meanwhile, Heartbeat provides information about a number of trips that are still on a smartphone.

Last Date Heartbeat

Date and Time of the latest heartbeat. this information can be used to have the information about the last time SDK activities. If the date is more than 24 hours ago, it usually means that the users has removed the application or has no internet connection for this period or has some issues with permissions or issues with a smartphone.

SDK version

A version of the SDK

Stages of data management workflow

Stages

Short description

Received tracks

The number of tracks we received from SDK to our servers

Invalid tracks

The number of tracks which contain mistakes or can't be recognized as a vehicle trip

Processed tracks

The number of tracks that were recognized as valid tracks and were forwarded for processing

Excluded tracks

The number of tracks that were excluded due to insufficient trip metrics to be recognized as a vehicle trip (for example, the length of the track was not long enough)

Enriched tracks

The number of tracks that were processed as vehicle trips. These trips are available for users via a mobile application, UserDataHub, and trip API

Additional information

Field

Short description

Last Track Date

Latest Enriched Track Date

Last known Latitude and Longitude

Latest known location.

Device

  • Device model
  • Device OS Version

User permissions

We identify two levels of permissions:

  • Device level
  • App level

Permissions

Impact

GPS

Crucial, SDK won't work

Motions

Some services won't be available (i.e. phone usage)

Mobile data

Delay with trip processing

WiFi

  • Low accuracy of location data
  • Possible GPS noise
  • Android: increased battery consumption

Low precise location

Crucial, SDK won't work

Low power mode

inconsistent tracking

System data

You can download system data that is used as a source for DataTool and get detailed historical information about SDK states and trip recording and processing.

File name

What's there?

Received Tracks

A list of received trips including those that will be excluded or determined as invalid while processing

Received Track points

Recorded Waypoints

Excluded tracks

A list of excluded trips including a reason why the track was excluded

Invalid tracks

A list of invalid trips including a reason why the track was determined as invalid

Enriched tracks

A list of processed trips

Enriched track points

Processed trips waypoints

Heartbeats

History of Heartbeats, including information when trips started and stopped, the current sdk state and a number of not uploaded trips

User Management

List of users

This workspace gives you access to the user table with main activity information and menu items on the left-hand side.

Available items

  • Email
  • Phone
  • Registration date
  • Name
  • DeviceTokenDeviceToken - It is a unique ID that is generated by Datamotion telematics platform and used by Telematics SDK as a user identifier. SDK connects all telematics data to the Devicetoken and transfer to Datamotion platform. Then the DeviceToken is used across all our APIs and services as a unique app user ID.
  • Client ID (Your internal ID)
  • Activity Status
  • Safety score
  • Trip count
  • Mileage
  • Company
  • Application
  • User Group
    [Search and Filters
  • Search Users by DeviceTokenDeviceToken - It is a unique ID that is generated by Datamotion telematics platform and used by Telematics SDK as a user identifier. SDK connects all telematics data to the Devicetoken and transfer to Datamotion platform. Then the DeviceToken is used across all our APIs and services as a unique app user ID., Email, Phone, Name, Client ID (Your internal ID)
  • Filter Results by Registration Date, Activity Status, Company, Application, User Group

Export results in CSV format

Activity Status
block:parameters]
{
"data": {
"h-0": "Activity Status",
"h-1": "Description",
"0-0": "Active (green)",
"1-0": "Inactive (yellow)",
"2-0": "Lost (red)",
"3-0": "No Data (gray)",
"4-0": "Error (vinous)",
"0-1": "User has enriched tracks WITHIN last 14 days",
"1-1": "User has enriched tracks OVER last 14 days, but has excluded tracks WITHIN last 14 days, which means that Telematics SDK is active.",
"2-1": "User has enriched tracks OVER last 14 days and has excluded tracks OVER last 14 days, which usually means that the app was removed or any issues occurred.",
"3-1": "User has no enriched tracks and no excluded tracks, which means one of these:\n- user was created manually or through API, but app was not installed.\n- user has installed the application, but SDK hasn't been activated. Usually because of the required permissions haven't granted correctly.",
"4-1": "User has NO enriched tracks and has excluded and/or invalid tracks, which means one of these:\n- User really has no tracks that are valid for successful enrichment yet, and after a valid trip his status will be “active”\n- Restrictions on a device (ex. power management restrictions)\n- SDK was not installed properly\n- The device is defected (ex. a lot of GPS low-accuracy outliers or other errors)\nPlease, use DataTool CSV export to investigate it more carefully for each user with this status."
},
"cols": 2,
"rows": 5
}

Transfer user to another group

This function allows you to move users between usergroups

Profile

Individual Safety Dashboard

Vehicle Management

Using this interface, you can manage vehicles connected to the user and export raw in-vehicle data collected by Bluetooth OBD

Delete a user

Use the function carefully as it completely deletes the user record and the whole set of telematics data associated with the users without options to recover it. Also, this function is available via method Delete a user

Permissions

The workspace provides a user permissions overview. :point-right: Fields description

List of trips

The workspace allows you to search for processed trips by User or TripToken applying flexible filters, and to export this data.

Trip details

The workspace allows you to discover each specific trip including Raw data points, Scores, Statistics, Events (incl. Speeding and Phone Usage), Trip Analytics etc.

Updated 10 days ago


UserDataHub


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.