| Segment | Description |
|---|---|
| Physical Activity | evaluates how much the user is involved in physical activities |
| Mobility | evaluates how much the user is on the move |
| Social Activity | evaluates how much the user is involved in social engagement |
| Segment | Description |
|---|---|
| Bar goer | enjoys evenings out at a pub or bar |
| Fresh food enthousiast | shops for food often |
| Healthy biker | frequently bikes for long distances |
| Healthy walker | frequently walks for long distances |
| Nature lover | likes to go out to a park, public garden, zoo or nature reserve |
| Resto lover | likes eating out |
| Shopaholic | shops a lot |
| Sportive | sports regularly |
| Segment | Description |
|---|---|
| Die hard driver | uses the car for almost every trip |
| Easy commuter | has an easy commute to/from work |
| Frequent flyer | frequently flies |
| Green commuter | mostly sticks to walking and biking for commutes |
| Heavy commuter | has a heavy commute to/from work |
| Long commuter | lives far from their work location |
| Normal commuter | has an average commute time and distance |
| Public transports user | often travels with public transports |
| Public transports commuter | often commutes with public transports |
| Short commuter | lives close to their work location |
| Segment | Description |
|---|---|
| Early bird | whose first morning activity is earlier than average |
| Fulltime worker | works full-time |
| Home bound | does not leave the house very often or travels very far |
| Homebody | prefers to stay at home on weekends and outside business hours |
| Homeworker | works from home or who is unemployed |
| Late worker | works until late |
| Night owl | whose last evening activity is later than average |
| Nightworker | works at night |
| Parttime worker | works part-time |
| Sleep deprived | sleeps very little |
| Student or teacher | a student or teacher |
| Uber parent | a parent who drives his/her kids to school, kindergarten or day care |
| Work life balancce | has a good balance between work and home life |
| Work traveller | works a lot remotely (travelling or in remote environments) |
| Workaholic | works more than average |
| UNKNOWN | Unknown venue |
| DRINK_DAY | Cafes, coffee bars, tea rooms, etc |
| DRINK_EVENING | Bars, pubs and in general places where one goes for drinks in evenings. |
| EDUCATION_INDEPENDENT | Educational institutions visited by the user on his own for their own studies. High schools, universities, colleges, etc. |
| EDUCATION_PARENTS | Schools and kindergartens visited by parents. |
| HEALTH | Hospitals, clinics, emergency rooms. |
| INDUSTRIAL | Buildings tagged as “industrial” on OSM, built for some manufacturing process. |
| LEISURE_BEACH | Beaches, resorts and swimming areas. |
| LEISURE_DAY | Bowling, billiards and other entertainment places. |
| LEISURE_EVENING | Cinemas, theatres and music halls. |
| LEISURE_MUSEUM | Museums |
| LEISURE_NATURE | Forests, lakes, national parks, etc. |
| LEISURE_PARK | City parks, gardens, zoos. |
| OFFICE | Office buildings. For example, of private lawyers, notaries or company representatives. |
| RELIGION | Churches, mosques and other religion related buildings. |
| RESIDENTIAL | Apartment blocks, houses. |
| RESTO_MID | Food courts, restaurants, snack bars. |
| RESTO_SHORT | Ice cream, fast food, donut stores. |
| SHOP_LONG | Supermarkets, malls, wholesales, shopping centres. |
| SHOP_SHORT | Small grocery stores, butchers, bakers. |
| SPORT | Gyms, sport centres. Venues visited to exercise. |
| SPORT_ATTEND | Stadiums. Venues visited to attend a sport event. |
| TRAVEL_BUS | Bus stops. |
| TRAVEL_CONFERENCE | Conference, convention, exhibition centres. |
| TRAVEL_FILL | Gas stations. |
| TRAVEL_HOTEL | travel_hotel- Hotels, motels, guest rooms, etc. |
| TRAVEL_LONG | Airports |
| TRAVEL_SHORT | Public transport stations, railway stations. |
| ICT Basic | ICT Premium |
|---|---|
The Basic bundle allows the integration of the SDK and provides a overview of:
| The Premium bundle expands analytical capabilities and enables deeper interaction with the data.
|
| Scope name | Scope description |
|---|---|
| USER_READ | Use this scope to read user data. |
| USER_DELETE | Use this scope to delete a user along with all historical data. |
| USER_LINK | Use this scope to perform User Creation & Authentication. |
| OFFLOADS_READ | Use this scope to list Offloads available for download. |
| OFFLOADS_GENERATE_URL | Use this scope to generate URLs at which offloads can be downloaded. |
| FAKE_DATA_INSERT | Use this scope to inject fake. Engagement platform only! |
...
dependencies {
implementation(platform("com.sentiance:sdk-bom:x.y.+"))
}
flutter {
source = "../.."
}
...
import sentiance_core
...
GeneratedPluginRegistrant.register(with: self)
let sentianceInit = SentianceCorePlugin.shared.initialize()
if sentianceInit.isSuccessful {
print("Sentiance SDK initialized")
}
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
}
| Check | Description |
|---|---|
| SSL Certificate | Valid certificate present on the endpoint |
| Auth Credentials | Correct Basic Auth credentials accepted |
| Auth Rejection | Incorrect credentials are rejected (tested explicitly) |
| App ID | GET endpoint returns the correct Sentiance Application ID To ensure the data gets sent to the correct Application ID |
| Payload Handling | POST endpoint correctly processes test payloads. These test payloads can be identified by looking for the HTTP header sentiance-payload-type: test |
import 'package:sentiance_driving_insights/sentiance_driving_insights.dart';
final sentianceDrivingInsights = SentianceDrivingInsights();
void getDrivingInsightsForTransport() async {
String transportId = "your_transport_id";
final drivingInsights = await sentianceDrivingInsights.getDrivingInsights(transportId);
if (drivingInsights != null) {
final transportEvent = drivingInsights.transportEvent;
final safetyScores = drivingInsights.safetyScores;
print('Focus score: ${safetyScores.focusScore}');
print('Legal score: ${safetyScores.legalScore}');
print('Smooth score: ${safetyScores.smoothScore}');
print('Call-while-moving score: ${safetyScores.callWhileMovingScore}');
print('Overall score: ${safetyScores.overallScore}');
print('Event ID: ${transportEvent.id}');
print('Started on: ${transportEvent.startTimeMs}');
print('Ended on: ${transportEvent.endTimeMs}');
print('Last updated on: ${transportEvent.lastUpdateTimeMs}');
print('Mode: ${transportEvent.transportMode}');
print('Duration in seconds: ${transportEvent.durationInSeconds}');
print('Distance: ${transportEvent.distance}');
print('Waypoints: [${transportEvent.waypoints.map((wp) => wp.toString()).join(", ")}]');
}
}
// Harsh driving events, used for computing the smooth driving score
DrivingInsightsApi.getInstance(context).getHarshDrivingEvents(transportId)
.forEach { harshDrivingEvent ->
print("Start time: ${harshDrivingEvent.startTime}")
print("End time: ${harshDrivingEvent.endTime}")
print("Magnitude: ${harshDrivingEvent.magnitude}")
}
// Phone usage events, used for computing the focused driving score
DrivingInsightsApi.getInstance(context).getPhoneUsageEvents(transportId)
.forEach { phoneUsageEvent ->
print("Start time: ${phoneUsageEvent.startTime}")
print("End time: ${phoneUsageEvent.endTime}")
}
// Call-while-moving events, used for computing the call-while-moving score
DrivingInsightsApi.getInstance(context).getCallWhileMovingEvents(transportId)
.forEach { callWhileMovingEvent ->
print("Start time: ${callWhileMovingEvent.startTime}")
print("End time: ${callWhileMovingEvent.endTime}")
print("Min traveled speed: ${callWhileMovingEvent.minTraveledSpeedInMps}")
print("Max traveled speed: ${callWhileMovingEvent.maxTraveledSpeedInMps}")
}
// Speeding events, used for computing the legal driving score
DrivingInsightsApi.getInstance(context).getSpeedingEvents(transportId)
.forEach { speedingEvent ->
print("Start time: ${speedingEvent.startTime}")
print("End time: ${speedingEvent.endTime}")
print("Waypoints: ${speedingEvent.waypoints}")
}
import SentianceCore from "@sentiance-react-native/core";
import {
addVehicleCrashEventListener
} from '@sentiance-react-native/crash-detection';
await SentianceCore.ensureInitialized();
addVehicleCrashEventListener(crashEvent => {
const time = crashEvent.time;
const location = crashEvent.location;
const magnitude = crashEvent.magnitude;
const speedAtImpact = crashEvent.speedAtImpact;
const deltaV = crashEvent.deltaV;
const confidence = crashEvent.confidence;
const severity = crashEvent.severity;
});
| Speed at impact | The estimated speed of the vehicle before the impact, in m/s. |
| Magnitude | The magnitude of the impact, in m/s². |
| Delta-V | The estimated change in velocity at impact, in m/s. |
| Confidence | The level of confidence that the accelerometer signal reflects a true crash pattern (range 0 - 100). It is recommended to filter out events below the confidence of 50. |
| Severity | A categorical severity of the crash (low, medium, high). |
| Score | Comment |
|---|---|
| FOCUS_SCORE | Acknowledges periods of attentive driving or riding without active phone handling |
| CALL_WHILE_MOVING_SCORE | Identifies instances where drivers or riders avoid making calls while moving over a speed of 15 km/h |
| ATTENTION_SCORE | Acknowledges periods of attentive driving without distractions like hands free calling, handheld calling, phone handling or screen use |
| LEGAL_SCORE | Rewards adherence to speed limits |
| MFFS_SCORE | Variation of LEGAL_SCORE that excludes congested roads |
| HARSH_MOVEMENT_SCORE | Recognises sequences of smooth driving, emphasising gentle acceleration and braking |
| SMOOTH_SCORE | Similar to HARSH_MOVEMENT_SCORE but also takes into account harsh turning events |
| Streaks | Comment |
|---|---|
| FOCUS_SCORE | Acknowledges periods of attentive driving without active phone handling |
| CALL_WHILE_MOVING_SCORE | Identifies instances where drivers avoid making calls while moving over a speed of 15 km/h |
| ATTENTION_SCORE | Acknowledges periods of attentive driving without distractions like hands free calling, handheld calling, phone handling or screen use |
| LEGAL_SCORE | Rewards adherence to speed limits |
| MFFS_SCORE | Variation of LEGAL_SCORE that excludes congested roads |
| HARSH_MOVEMENT_SCORE | Recognises sequences of smooth driving, emphasising gentle acceleration and braking |
| SMOOTH_SCORE | Similar to HARSH_MOVEMENT_SCORE but also takes into account harsh turning events |
| Category | |
|---|---|
| ALL | Messages relevant to all aspects of the app's engagement features. |
| CHALLENGES | Communications specific to the challenges users are participating in or have completed. |
| BADGES | Messages related to badges earned for various achievements. |
| STREAKS | Updates and information on users' streaks. |
| SCORES | Communications concerning users' scores from their driving behavior |
| LEADERBOARD | Messages related to leaderboard standings, encouraging competitive engagement. |
| TRIPS | Updates on users' trips. |
| PROFILE | Messages related to the user's profile information or updates. |
| SCHEDULED | Scheduled messages meant for timely delivery on specific dates or events. |
| Type | Comment |
|---|---|
| IN_APP_MESSAGE | Direct messages displayed within the app, providing immediate feedback or information. |
| REACTIVE_MESSAGE | Messages triggered by specific user actions or behaviors, offering real-time engagement. (e.g you have successfully completed your challenge) |
mutation Delete_group_poi(
$group_id: String, # ID of the group
$poi_id: String # ID of the POI
) {
delete_group_poi(
group_id: $group_id,
poi_id: $poi_id
) {
status # Success or failure status
}
}
# VARIABLES
{
"group_id": "group123",
"poi_id": "poi456"
}
| SDK Version | Minimum API Level (Compilation) | Required API Level for Detections |
|---|---|---|
| 4.0.0 - 4.14.0 | 14 | 14+ |
| 4.16.0 - 4.22.x | 14 | 21+ |
| 6.0.0 - 6.10.1 | 23 | 23+ |
| 6.11.0 - | 24 | 24+ |
| Integration Method | Notes |
|---|---|
| CocoaPods | The Sentiance SDK podspec references the official Pod hosted on CocoaPods. It does not support ARM simulators. You have the option of using Sentiance's repackaged framework instead. |
| SPM | There is no official Swift package. The Sentiance package references a Sentiance-hosted framework, which is a repackaged version that support ARM simulators too. |
| Manual | A custom repackaged version of the framework is used, which also supports ARM simulators. |
| Integration Method | Notes |
|---|---|
| CocoaPods | The Sentiance SDK podspec references the official Pod hosted on CocoaPods. |
| SPM | There is no official Swift package. The Sentiance package references a Sentiance-hosted framework v3.18.3-p, which is a packaged version of the ProtocolBuffers source code, with an added Apple Privacy Manifest file. |
| Manual | A Sentiance-packaged framework, v3.18.3-p, built from the ProtocolBuffers source code, with an added Apple Privacy Manifest file. |
| Integration Method | Notes |
|---|---|
| CocoaPods | The Sentiance SDK podspec references the official Pod hosted on CocoaPods. |
| SPM | There is no official Swift package. The Sentiance package references a Sentiance-hosted framework, which is a packaged version of the UnzipKit source code. |
| Manual | A Sentiance-packaged framework, built from the UnzipKit source code. |
| Scope name | Scope description |
|---|---|
| USER_READ | Use this scope to read user data. This scope should be used with the Sentiance GraphQL |
| USER_DELETE | Use this scope to delete a user along with all historical data. |
| USER_LINK | Use this scope to perform User Creation & Authentication. |
| OFFLOADS_READ | Use this scope to list Offloads available for download. |
| OFFLOADS_GENERATE_URL | Use this scope to generate URLs at which offloads can be downloaded. |
| FAKE_DATA_INSERT | Use this scope to inject fake data. Engagement platform only! |
| Method | Description |
|---|---|
| enableDetections() | Prepares the SDK for detection. Verifies permissions, sensors, and location services. Does not immediately start data collection. |
| disableDetections() | Stops the SDK from performing any further detections. |
| Old Name | New Name |
|---|---|
| MetaUserLinker | UserLinker |
| MetaUserLinkerAsync | UserLinkerAsync |
| MetaUserLinkerCallback | UserLinkerCallback |
| Deprecated Method | Replacement Method |
|---|---|
| reset(ResetCallback) | reset() |
| getUserAccessToken(TokenResultCallback) | requestUserAccessToken() |
| startTrip(Map, TransportMode, StartTripCallback) | startTrip(Map, TransportMode) |
| stopTrip(StopTripCallback) | stopTrip() |
| submitDetections(SubmitDetectionsCallback) | submitDetections() |
| Old Name | New Name |
|---|---|
| MetaUserLinker | SENTUserLinker |
| setTripTimeOutListener: | setTripTimeoutListener: |
| Old Method | New Property |
|---|---|
| getInitState | initState |
| getSDKStatus | sdkStatus |
| getVersion | version |
| getWifiQuotaLimit | wifiQuotaLimit |
| getWifiQuotaUsage | wifiQuotaUsage |
| getMobileQuotaLimit | mobileQuotaLimit |
| getMobileQuotaUsage | mobileQuotaUsage |
| getDiskQuotaLimit | diskQuotaLimit |
| getDiskQuotaUsage | diskQuotaUsage |
| Deprecated Method | Replacement Method |
|---|---|
| start:completion: | enableDetectionsWithCompletionHandler: |
| startWithStopDate:completion: | enableDetectionsWithExpiryDate: completionHandler: |
| stop | disableDetectionsWithCompletionHandler: |
| getUserAccessToken:failure: | requestUserAccessTokenWithCompletionHandler: |
| startTrip:transportModeHint: success:failure: | startTripWithMetadata: transportModeHint: completionHandler: |
| stopTrip:failure: | stopTripWithCompletionHandler: |
| submitDetections:failure: | submitDetectionsWithCompletionHandler: |
| requestUserContext:failure: | requestUserContextWithCompletionHandler: |
| reset:failure: | resetWithCompletionHandler: |
| Old Name | New Name |
|---|---|
| SDKStatusUpdate | SENTIANCE_STATUS_UPDATE_EVENT |
| SDKUserLink | SENTIANCE_USER_LINK_EVENT |
| SDKUserActivityUpdate | SENTIANCE_USER_ACTIVITY_UPDATE_EVENT |
| SDKTripTimeout | SENTIANCE_ON_TRIP_TIMED_OUT_EVENT |
| VehicleCrashEvent | SENTIANCE_VEHICLE_CRASH_EVENT |
| Deprecated function | Replacement function |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| Deleted functions |
|---|
|
|
|
|
|
|
|
| Deprecated function | Replacement function |
|---|---|
| |
| |
| |
| |
| Before migrating | After migrating |
|---|---|
SentianceUserContextListenerApi.setUp(...) | SentianceUserContext.registerUserContextUpdateListener() |
SentianceEventTimelineListenerApi.setUp(...) | SentianceEventTimeline.registerEventTimelineUpdateListener() |
SentianceSmartGeofencesListenerApi.setUp(...) | SentianceSmartGeofences.registerSmartGeofenceEventListener() |
SentianceCrashDetectionListenerApi.setUp(...) | SentianceCrashDetection.registerCrashListener()SentianceCrashDetection.registerCrashDiagnosticListener() |
SentianceDrivingInsightsListenerApi.setUp(...) | SentianceDrivingInsights.registerDrivingInsightsListener() |
| Feature | Early Access Version | Production Ready Version |
| General Purpose Sensor Data Collection | Android: 1.0.0 iOS: 1.0.0 | |
| Automatic Stationary and Trip Detection | Android: 1.0.0 iOS: 1.0.0 | |
| User Linking | Android: 4.1.22 iOS: 5.1.0 | |
| User Activity Information | Android:4.7.0 iOS: 5.3.0 | |
| SDK Reset | Android: 4.14.0 iOS: 5.6.0 | |
| Vehicle Crash Detection | Android: 4.1.21 iOS: 5.1.4 | Android: 4.20.0 iOS: 5.9.0 |
| Transport Classification | Android: 6.0.0 iOS: 6.0.0 | Android: 6.4.0 iOS: 6.4.0 |
| Home & Work Detection | Android: 6.0.0 iOS: 6.0.0 | Android: 6.4.0 iOS: 6.4.0 |
| Event Timeline | Android 6.6.0 iOS 6.6.0 | |
| User Segment Detection | Android: 6.0.0 iOS: 6.0.0 | Android: 6.4.0 iOS: 6.4.0 |
| User Current Context Information | Android: 6.0.0 iOS: 6.0.0 | Android: 6.4.0 iOS: 6.4.0 |
| Venue Type Mapping Information | Android: 6.0.0 iOS: 6.0.0 | |
| Semantic Time | Android: 6.2.0 iOS: 6.2.0 | |
| Driving Insights | Android: 6.3.0 iOS: 6.3.0 | Android: 6.8.0 iOS: 6.8.0 |
| Smart Geofences | Android: 6.8.0 iOS: 6.8.0 |