Sentiance Graphql V4

An intro to Sentiance's version 4 Graphql API.

Contact

Support

Terms of Service

API Endpoints

# Endpoint:
https://api.sentiance.com/v4/gql

Headers

Authorization: Bearer <YOUR_API_KEY_HERE>

Intro

Our API primarily speaks GraphQL (GQL, for short). While explaining how GraphQL works is beyond the scope of this guide, there are excellent resources available on the interwebs. Here we will introduce the basic request-response structure of the Sentiance GraphQL API.

Endpoint and Authorization

Our default GraphQL endpoint lives at POST https://api.sentiance.com/v4/gql and accepts the same bearer token based authorization. We adhere to the GraphQL specification but do not support multiple operation types. Since it is possible for a single HTTP request to encompass multiple GraphQL queries with some of them succeeding and some of them failing, the endpoint always returns a 200 OK, unless something severe enough happens on the server-side to guarantee failure of the entire response (such as a 500 status code). After checking for the 200 status code, please also check the body of the response for data and error properties.

Queries

`custom_offloads`

Response

Returns [CustomOffload]

Arguments

Name	Description
`export_id` - `String`

Example

Query

query Custom_offloads($export_id: String) {
  custom_offloads(export_id: $export_id) {
    day
    files {
      link {
        ...LinkFragment
      }
      name
      format
      size
    }
    id
    name
  }
}

Variables

{"export_id": "abc123"}

Response

{
  "data": {
    "custom_offloads": [
      {
        "day": "xyz789",
        "files": [OffloadFile],
        "id": "abc123",
        "name": "abc123"
      }
    ]
  }
}

Queries

`engagement`

Description

Engagement data.

Response

Returns an Engagement

Example

Query

query Engagement {
  engagement {
    group {
      created_at
      group_id
      members {
        ...UserEngagementGroupMembersFragment
      }
      name
      points_of_interest {
        ...UserEngagementGroupPoisFragment
      }
      reg_code
      feed {
        ...UserEngagementGroupFeedFragment
      }
      leaderboard {
        ...UserEngagementGroupLeaderboardFragment
      }
    }
  }
}

Response

{"data": {"engagement": {"group": UserEngagementGroup}}}

Queries

`iql`

Description

IQL data.

Response

Returns an IQL

Example

Query

query Iql {
  iql {
    carriers {
      slice {
        ...IQLCarrierFragment
      }
    }
    disclaimer_text {
      informative_text {
        ...TemplatedTextFragment
      }
      first_tick_box_text {
        ...TemplatedTextFragment
      }
      second_tick_box_text {
        ...TemplatedTextFragment
      }
      version
    }
    region
  }
}

Response

{
  "data": {
    "iql": {
      "carriers": IQLCarriers,
      "disclaimer_text": IQLDisclaimerText,
      "region": "abc123"
    }
  }
}

Queries

`offloads`

Response

Returns [Offload]

Arguments

Name	Description
`from` - `String`
`to` - `String`

Example

Query

query Offloads(
  $from: String,
  $to: String
) {
  offloads(
    from: $from,
    to: $to
  ) {
    files {
      link {
        ...LinkFragment
      }
      name
      format
      size
    }
    type
    day
  }
}

Variables

{
  "from": "xyz789",
  "to": "abc123"
}

Response

{
  "data": {
    "offloads": [
      {
        "files": [OffloadFile],
        "type": "OFFLOAD_TYPE_APP_EVENTS",
        "day": "2023-03-04"
      }
    ]
  }
}

Queries

`transport`

Response

Returns a Transport

Arguments

Name	Description
`transport_id` - `String`

Example

Query

query Transport($transport_id: String) {
  transport(transport_id: $transport_id) {
    additional_mobility_details {
      raw_data_points {
        ...RawDataPointsFragment
      }
    }
    crash_events {
      crash_event {
        ...CrashEventFragment
      }
    }
    end_at
    metadata
    start_at
    scores {
      safety {
        ...TransportScoresSafetyFragment
      }
    }
    occupant_role
    trajectory {
      end_location {
        ...LocationInformationFragment
      }
      start_location {
        ...LocationInformationFragment
      }
      polyline
      map_matched_waypoints {
        ...MapMatchedWaypointFragment
      }
      distance
      top_speed
    }
    mode
    transport_id
    weather_data {
      weather_at_destination {
        ...WeatherDataFragment
      }
      weather_at_origin {
        ...WeatherDataFragment
      }
    }
    top_speed
    duration
    driving_events {
      accelerating {
        ...AcceleratingEventFragment
      }
      braking {
        ...BrakingEventFragment
      }
      calls {
        ...CallEventFragment
      }
      mounted {
        ...MountedEventFragment
      }
      phone_handling {
        ...PhoneHandlingEventFragment
      }
      screens {
        ...ScreenEventFragment
      }
      speeding {
        ...SpeedingEventFragment
      }
      turning {
        ...TurningEventFragment
      }
      wrong_way_events {
        ...WrongWayEventFragment
      }
    }
  }
}

Variables

{"transport_id": "abc123"}

Response

{
  "data": {
    "transport": {
      "additional_mobility_details": AdditionalMobilityDetails,
      "crash_events": CrashEventsForTransport,
      "end_at": "xyz789",
      "metadata": "xyz789",
      "start_at": "abc123",
      "scores": TransportScores,
      "occupant_role": "abc123",
      "trajectory": TransportTrajectory,
      "mode": "xyz789",
      "transport_id": "abc123",
      "weather_data": TransportWeatherData,
      "top_speed": 987.65,
      "duration": 987,
      "driving_events": TransportDrivingEvents
    }
  }
}

Queries

`user`

Response

Returns a User

Arguments

Name	Description
`external_id` - `String`	External ID of the user. This is the ID of the user in your system. External ID based queries are only supported for API Keys. If both user_id and external_id are provided, user_id will be used.
`user_id` - `String`	Sentiance ID of the user. This is the ID of the user in the Sentiance platform. If both user_id and external_id are provided, user_id will be used.

Example

Query

query User(
  $external_id: String,
  $user_id: String
) {
  user(
    external_id: $external_id,
    user_id: $user_id
  ) {
    app_id
    created_at
    diagnostics {
      off_the_grids {
        ...OffTheGridFragment
      }
    }
    engagement {
      communications {
        ...UserEngagementCommunicationsFragment
      }
      library {
        ...UserEngagementLibraryFragment
      }
      badges {
        ...UserEngagementBadgesFragment
      }
      challenges {
        ...UserEngagementChallengesFragment
      }
      groups {
        ...UserEngagementGroupsFragment
      }
      transports {
        ...UserEngagementTransportsFragment
      }
      streaks {
        ...UserEngagementStreaksFragment
      }
      scores {
        ...UserEngagementScoresFragment
      }
      transport {
        ...UserEngagementTransportFragment
      }
      aggregations {
        ...UserEngagementAggregationsFragment
      }
    }
    external_id
    iql {
      program_status {
        ...IQLUserStateFragment
      }
    }
    user_id
    scores {
      driving {
        ...UserScoresDrivingFragment
      }
    }
    feedback_events {
      actual_value
      expected_value
      event_id
      meta_info {
        ...FeedbackEventMetaInfoFragment
      }
      reason
      user_id
      created_at
      updated_at
      type
    }
    transports {
      additional_mobility_details {
        ...AdditionalMobilityDetailsFragment
      }
      crash_events {
        ...CrashEventsForTransportFragment
      }
      end_at
      metadata
      start_at
      scores {
        ...TransportScoresFragment
      }
      occupant_role
      trajectory {
        ...TransportTrajectoryFragment
      }
      mode
      transport_id
      weather_data {
        ...TransportWeatherDataFragment
      }
      top_speed
      duration
      driving_events {
        ...TransportDrivingEventsFragment
      }
    }
  }
}

Variables

{
  "external_id": "xyz789",
  "user_id": "xyz789"
}

Response

{
  "data": {
    "user": {
      "app_id": "xyz789",
      "created_at": "xyz789",
      "diagnostics": Diagnostics,
      "engagement": UserEngagement,
      "external_id": "xyz789",
      "iql": IQLUser,
      "user_id": "abc123",
      "scores": UserScores,
      "feedback_events": [FeedbackEvent],
      "transports": [Transport]
    }
  }
}

Mutations

`abandon_challenge`

Description

Mutation for abandoning a challenge.

Response

Returns an AbandonUserEngagementChallenge

Arguments

Name	Description
`challenge_id` - `String`	ID of the challenge to be abandoned.

Example

Query

mutation Abandon_challenge($challenge_id: String) {
  abandon_challenge(challenge_id: $challenge_id) {
    status
  }
}

Variables

{"challenge_id": "xyz789"}

Response

{"data": {"abandon_challenge": {"status": false}}}

Mutations

`accept_challenge`

Description

Mutation for accepting a challenge.

Response

Returns an AcceptUserEngagementChallenge

Arguments

Name	Description
`challenge_id` - `String`	ID of the challenge to be accepted.

Example

Query

mutation Accept_challenge($challenge_id: String) {
  accept_challenge(challenge_id: $challenge_id) {
    status
  }
}

Variables

{"challenge_id": "abc123"}

Response

{"data": {"accept_challenge": {"status": true}}}

Mutations

`approve_group_join`

Description

Mutation for approving a user to join a group.

Response

Returns an ApproveUserEngagementJoin

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`pending_user_id` - `String`	Sentiance ID of the user to be accepted.

Example

Query

mutation Approve_group_join(
  $group_id: String,
  $pending_user_id: String
) {
  approve_group_join(
    group_id: $group_id,
    pending_user_id: $pending_user_id
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "pending_user_id": "xyz789"
}

Response

{"data": {"approve_group_join": {"status": true}}}

Mutations

`check_iql_permitted_status`

Description

Check if the user is permitted to start an IQL test drive.

Response

Returns an CheckIQLPermittedStatus

Arguments

Name	Description
`current_carrier_id` - `String`
`disclaimer_text_version` - `String`
`zipcode` - `String`

Example

Query

mutation Check_iql_permitted_status(
  $current_carrier_id: String,
  $disclaimer_text_version: String,
  $zipcode: String
) {
  check_iql_permitted_status(
    current_carrier_id: $current_carrier_id,
    disclaimer_text_version: $disclaimer_text_version,
    zipcode: $zipcode
  ) {
    permitted
  }
}

Variables

{
  "current_carrier_id": "abc123",
  "disclaimer_text_version": "xyz789",
  "zipcode": "abc123"
}

Response

{"data": {"check_iql_permitted_status": {"permitted": true}}}

Mutations

`create_fake_transport`

Description

Mutation for creating a fake transport.

Response

Returns a CreateFakeTransport

Arguments

Name	Description
`with_crash_events` - `Boolean`	Flag to include crash events in the transport. Not yet implemented.
`with_trajectory` - `Boolean`	Flag to include trajectory in the transport payload. Trajectory is the list of waypoints (lat, long) of the transport. We use the trajectory to determine the total distance of the transport.
`mode` - `CreateFakeTransportRequest_TransportModeEnum`	Mode of the transport.
`safety_scores` - `CreateFakeTransportRequest_SafetyScoresInput`	Safety scores for the transport. Only applies to some transport modes: CAR, BUS, MOTORCYCLE.
`user_id` - `String`	Sentiance ID of the user.

Example

Query

mutation Create_fake_transport(
  $with_crash_events: Boolean,
  $with_trajectory: Boolean,
  $mode: CreateFakeTransportRequest_TransportModeEnum,
  $safety_scores: CreateFakeTransportRequest_SafetyScoresInput,
  $user_id: String
) {
  create_fake_transport(
    with_crash_events: $with_crash_events,
    with_trajectory: $with_trajectory,
    mode: $mode,
    safety_scores: $safety_scores,
    user_id: $user_id
  ) {
    transport_id
  }
}

Variables

{
  "with_crash_events": true,
  "with_trajectory": true,
  "mode": "BICYCLE",
  "safety_scores": CreateFakeTransportRequest_SafetyScoresInput,
  "user_id": "abc123"
}

Response

{
  "data": {
    "create_fake_transport": {
      "transport_id": "xyz789"
    }
  }
}

Mutations

`create_feedback_event`

Description

Mutation for creating a feedback event.

Response

Returns a CreateFeedbackEvent

Arguments

Name	Description
`actual_value` - `String`	Actual value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`expected_value` - `String`	Expected value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`event_id` - `String`	ID of the transport/event.
`meta_info` - `FeedbackEventMetaInfoInput`	Meta information for the feedback event. deprecated: use expected_value, actual_value instead.
`reason` - `String`	Reason feedback is provided.
`type` - `FeedbackTypeEnum`	Type of feedback.

Example

Query

mutation Create_feedback_event(
  $actual_value: String,
  $expected_value: String,
  $event_id: String,
  $meta_info: FeedbackEventMetaInfoInput,
  $reason: String,
  $type: FeedbackTypeEnum
) {
  create_feedback_event(
    actual_value: $actual_value,
    expected_value: $expected_value,
    event_id: $event_id,
    meta_info: $meta_info,
    reason: $reason,
    type: $type
  ) {
    feedback_event {
      actual_value
      expected_value
      event_id
      meta_info {
        ...FeedbackEventMetaInfoFragment
      }
      reason
      user_id
      created_at
      updated_at
      type
    }
  }
}

Variables

{
  "actual_value": "abc123",
  "expected_value": "xyz789",
  "event_id": "abc123",
  "meta_info": FeedbackEventMetaInfoInput,
  "reason": "abc123",
  "type": "FEEDBACK_TYPE_CRASH"
}

Response

{
  "data": {
    "create_feedback_event": {
      "feedback_event": FeedbackEvent
    }
  }
}

Mutations

`create_group`

Description

Mutation for creating a new group.

Response

Returns a CreateUserEngagementGroup

Arguments

Name	Description
`origin` - `String`	A String representing the origin of the group. Ex: 'client_app', 'web_platform', etc
`features` - `CreateUserEngagementGroupRequest_UserEngagementGroupFeaturesInput`	Features to be enabled for the group.
`name` - `String`	Name of the new group.
`ranking_attributes` - `[UserEngagementGroupRankingAttributeEnum]`	Ranking attributes to be used for the group leaderboard. Available options: DRIVER_COACHING_SCORE.
`group_type` - `UserEngagementGroupTypeEnum`	Type of the new group. Supported types: SOCIAL.

Example

Query

mutation Create_group(
  $origin: String,
  $features: CreateUserEngagementGroupRequest_UserEngagementGroupFeaturesInput,
  $name: String,
  $ranking_attributes: [UserEngagementGroupRankingAttributeEnum],
  $group_type: UserEngagementGroupTypeEnum
) {
  create_group(
    origin: $origin,
    features: $features,
    name: $name,
    ranking_attributes: $ranking_attributes,
    group_type: $group_type
  ) {
    group {
      created_at
      group_id
      members {
        ...UserEngagementGroupMembersFragment
      }
      name
      points_of_interest {
        ...UserEngagementGroupPoisFragment
      }
      reg_code
      feed {
        ...UserEngagementGroupFeedFragment
      }
      leaderboard {
        ...UserEngagementGroupLeaderboardFragment
      }
    }
    status
  }
}

Variables

{
  "origin": "xyz789",
  "features": CreateUserEngagementGroupRequest_UserEngagementGroupFeaturesInput,
  "name": "xyz789",
  "ranking_attributes": ["DRIVER_COACHING_SCORE"],
  "group_type": "SOCIAL"
}

Response

{
  "data": {
    "create_group": {
      "group": UserEngagementGroup,
      "status": false
    }
  }
}

Mutations

`create_group_poi`

Description

Mutation for creating a new group POI.

Response

Returns a CreateUserEngagementGroupPoi

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`poi` - `EngagementPOIInput`	Point of Interest to be created.

Example

Query

mutation Create_group_poi(
  $group_id: String,
  $poi: EngagementPOIInput
) {
  create_group_poi(
    group_id: $group_id,
    poi: $poi
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "poi": EngagementPOIInput
}

Response

{"data": {"create_group_poi": {"status": true}}}

Mutations

`decline_group_join`

Description

Mutation for declining a user to join a group.

Response

Returns a DeclineUserEngagementJoin

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`pending_user_id` - `String`	Sentiance ID of the user to be declined.

Example

Query

mutation Decline_group_join(
  $group_id: String,
  $pending_user_id: String
) {
  decline_group_join(
    group_id: $group_id,
    pending_user_id: $pending_user_id
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "pending_user_id": "abc123"
}

Response

{"data": {"decline_group_join": {"status": true}}}

Mutations

`delete_feedback_event`

Description

Mutation for deleting a feedback event.

Response

Returns a DeleteFeedbackEvent

Arguments

Name	Description
`event_id` - `String`	ID of the transport/event.
`type` - `FeedbackTypeEnum`	Type of feedback.

Example

Query

mutation Delete_feedback_event(
  $event_id: String,
  $type: FeedbackTypeEnum
) {
  delete_feedback_event(
    event_id: $event_id,
    type: $type
  ) {
    status
  }
}

Variables

{
  "event_id": "xyz789",
  "type": "FEEDBACK_TYPE_CRASH"
}

Response

{"data": {"delete_feedback_event": {"status": true}}}

Mutations

`delete_group`

Description

Mutation for deleting a group.

Response

Returns a DeleteUserEngagementGroup

Arguments

Name	Description
`group_id` - `String`	ID of the group to delete.

Example

Query

mutation Delete_group($group_id: String) {
  delete_group(group_id: $group_id) {
    status
  }
}

Variables

{"group_id": "abc123"}

Response

{"data": {"delete_group": {"status": false}}}

Mutations

`delete_group_poi`

Description

Mutation for deleting a group POI.

Response

Returns a DeleteUserEngagementGroupPoi

Arguments

Name	Description
`poi_id` - `String`	ID of the Point of Interest.
`group_id` - `String`	ID of the group.

Example

Query

mutation Delete_group_poi(
  $poi_id: String,
  $group_id: String
) {
  delete_group_poi(
    poi_id: $poi_id,
    group_id: $group_id
  ) {
    status
  }
}

Variables

{
  "poi_id": "xyz789",
  "group_id": "abc123"
}

Response

{"data": {"delete_group_poi": {"status": false}}}

Mutations

`delete_user`

Response

Returns a DeleteUserById

Arguments

Name	Description
`id` - `String`

Example

Query

mutation Delete_user($id: String) {
  delete_user(id: $id) {
    request_id
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "delete_user": {"request_id": "xyz789"}
  }
}

Mutations

`generate_auth_code`

Response

Returns a GenerateAuthCode

Arguments

Name	Description
`external_id` - `String`

Example

Query

mutation Generate_auth_code($external_id: String) {
  generate_auth_code(external_id: $external_id) {
    authentication_code
    expires_at
  }
}

Variables

{"external_id": "abc123"}

Response

{
  "data": {
    "generate_auth_code": {
      "authentication_code": "xyz789",
      "expires_at": "abc123"
    }
  }
}

Mutations

`generate_custom_offload_url`

Response

Returns a GenerateCustomOffloadsUrl

Arguments

Name	Description
`day` - `String`
`export_id` - `String`

Example

Query

mutation Generate_custom_offload_url(
  $day: String,
  $export_id: String
) {
  generate_custom_offload_url(
    day: $day,
    export_id: $export_id
  ) {
    offload {
      day
      files {
        ...OffloadFileFragment
      }
      id
      name
    }
  }
}

Variables

{
  "day": "xyz789",
  "export_id": "xyz789"
}

Response

{
  "data": {
    "generate_custom_offload_url": {
      "offload": CustomOffload
    }
  }
}

Mutations

`generate_offload_url`

Response

Returns a GenerateUrl

Arguments

Name	Description
`day` - `String`
`offload_type` - `OffloadTypeEnum`

Example

Query

mutation Generate_offload_url(
  $day: String,
  $offload_type: OffloadTypeEnum
) {
  generate_offload_url(
    day: $day,
    offload_type: $offload_type
  ) {
    offload {
      files {
        ...OffloadFileFragment
      }
      type
      day
    }
  }
}

Variables

{
  "day": "xyz789",
  "offload_type": "OFFLOAD_TYPE_APP_EVENTS"
}

Response

{"data": {"generate_offload_url": {"offload": Offload}}}

Mutations

`join_group`

Description

Mutation for joining an existing group.

Response

Returns a JoinUserEngagementGroup

Arguments

Name	Description
`reg_code` - `String`	Registration code of the group.

Example

Query

mutation Join_group($reg_code: String) {
  join_group(reg_code: $reg_code) {
    status
  }
}

Variables

{"reg_code": "abc123"}

Response

{"data": {"join_group": {"status": false}}}

Mutations

`leave_group`

Description

Mutation for leaving a group the user is part of.

Response

Returns a LeaveUserEngagementGroup

Arguments

Name	Description
`group_id` - `String`	ID of the group.

Example

Query

mutation Leave_group($group_id: String) {
  leave_group(group_id: $group_id) {
    status
  }
}

Variables

{"group_id": "xyz789"}

Response

{"data": {"leave_group": {"status": false}}}

Mutations

`make_group_admin`

Description

Mutation for making a user an admin of a group.

Response

Returns a MakeUserEngagementGroupAdmin

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`new_admin_user_id` - `String`	Sentiance ID of the user to be made admin.

Example

Query

mutation Make_group_admin(
  $group_id: String,
  $new_admin_user_id: String
) {
  make_group_admin(
    group_id: $group_id,
    new_admin_user_id: $new_admin_user_id
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "new_admin_user_id": "xyz789"
}

Response

{"data": {"make_group_admin": {"status": true}}}

Mutations

`opt_out_of_iql_test_drive`

Description

Opt out of an IQL test drive.

Response

Returns an OptOutOfIQLTestDrive

Arguments

Name	Description
`abandon_type` - `IQLAbandonedUserStateContext_IQLAbandonTypeEnum`

Example

Query

mutation Opt_out_of_iql_test_drive($abandon_type: IQLAbandonedUserStateContext_IQLAbandonTypeEnum) {
  opt_out_of_iql_test_drive(abandon_type: $abandon_type) {
    success
  }
}

Variables

{"abandon_type": "IQL_ABANDON_TYPE_NEVER_ELIGIBLE"}

Response

{"data": {"opt_out_of_iql_test_drive": {"success": false}}}

Mutations

`remove_group_membership`

Description

Mutation for removing a user from a group.

Response

Returns a RemoveUserEngagementGroupMembership

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`removed_user_id` - `String`	Sentiance ID of the user to be removed.

Example

Query

mutation Remove_group_membership(
  $group_id: String,
  $removed_user_id: String
) {
  remove_group_membership(
    group_id: $group_id,
    removed_user_id: $removed_user_id
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "removed_user_id": "xyz789"
}

Response

{"data": {"remove_group_membership": {"status": true}}}

Mutations

`set_in_group_status`

Description

Mutation for setting the status of a user in a group.

Response

Returns a SetUserEngagementGroupStatus

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`status` - `String`	Status of the group. Any String to represent the status of the group. Empty String for no status/removing status
`expire_in` - `Int`	Time in seconds after which the status will expire. Default: 1 year (31.536.000 seconds)

Example

Query

mutation Set_in_group_status(
  $group_id: String,
  $status: String,
  $expire_in: Int
) {
  set_in_group_status(
    group_id: $group_id,
    status: $status,
    expire_in: $expire_in
  ) {
    status
  }
}

Variables

{
  "group_id": "abc123",
  "status": "abc123",
  "expire_in": 987
}

Response

{"data": {"set_in_group_status": {"status": true}}}

Mutations

`submit_log_event`

Description

Mutation for submitting log events.

Response

Returns a SubmitLogEvent

Arguments

Name	Description
`event_params` - `[SubmitLogEventRequest_EventParamsEntryInput]`	Map of parameters for the event.
`event_name` - `String`	Name of the event.

Example

Query

mutation Submit_log_event(
  $event_params: [SubmitLogEventRequest_EventParamsEntryInput],
  $event_name: String
) {
  submit_log_event(
    event_params: $event_params,
    event_name: $event_name
  ) {
    message
    status
  }
}

Variables

{
  "event_params": [
    SubmitLogEventRequest_EventParamsEntryInput
  ],
  "event_name": "xyz789"
}

Response

{
  "data": {
    "submit_log_event": {
      "message": "abc123",
      "status": false
    }
  }
}

Mutations

`submit_transport_feedback`

Description

Mutation for submitting transport feedback.

Response

Returns a TransportFeedback

Arguments

Name	Description
`grace` - `Boolean`	Flag for type of feedback. Adjusting a trip (true) or deleting a trip (false)
`entity_id` - `String`	ID of the entity feedback is provided for.
`context` - `[TransportFeedbackRequest_ContextEntryInput]`	Map of attributes describing the context feedback was provided.
`reason` - `String`	Reason feedback is provided. Available options: GENERIC, WAS_PASSENGER, WAS_DRIVER, WAS_FOCUSED, NOT_CAR_TRIP, VALID
`entity_type` - `String`	Type of entity. Available options: TRIP, CHALLENGE.
`origin` - `String`	Where the feedback originated from. Ex: Trips_page, Challenges_page, etc.

Example

Query

mutation Submit_transport_feedback(
  $grace: Boolean,
  $entity_id: String,
  $context: [TransportFeedbackRequest_ContextEntryInput],
  $reason: String,
  $entity_type: String,
  $origin: String
) {
  submit_transport_feedback(
    grace: $grace,
    entity_id: $entity_id,
    context: $context,
    reason: $reason,
    entity_type: $entity_type,
    origin: $origin
  ) {
    status
  }
}

Variables

{
  "grace": false,
  "entity_id": "abc123",
  "context": [TransportFeedbackRequest_ContextEntryInput],
  "reason": "xyz789",
  "entity_type": "abc123",
  "origin": "abc123"
}

Response

{"data": {"submit_transport_feedback": {"status": false}}}

Mutations

`submit_user_engagement_preferences`

Description

Mutation for submitting user preferences.

Response

Returns a SubmitUserEngagementPreferences

Arguments

Name	Description
`language_config` - `SubmitUserEngagementPreferencesRequest_LanguageConfigInput`	Option for choosing preferred language for a user.
`grace_config` - `SubmitUserEngagementPreferencesRequest_GraceConfigInput`	Option for enabling/disabling grace period for a user.
`location` - `EngagementCoordinatesInput`	Set location for the user

Example

Query

mutation Submit_user_engagement_preferences(
  $language_config: SubmitUserEngagementPreferencesRequest_LanguageConfigInput,
  $grace_config: SubmitUserEngagementPreferencesRequest_GraceConfigInput,
  $location: EngagementCoordinatesInput
) {
  submit_user_engagement_preferences(
    language_config: $language_config,
    grace_config: $grace_config,
    location: $location
  ) {
    message
    status
  }
}

Variables

{
  "language_config": SubmitUserEngagementPreferencesRequest_LanguageConfigInput,
  "grace_config": SubmitUserEngagementPreferencesRequest_GraceConfigInput,
  "location": EngagementCoordinatesInput
}

Response

{
  "data": {
    "submit_user_engagement_preferences": {
      "message": "abc123",
      "status": false
    }
  }
}

Mutations

`subscribe_group_poi`

Description

Mutation for subscribing to a group POI.

Response

Returns a SubscribeUserEngagementGroupPoi

Arguments

Name	Description
`poi_id` - `String`	ID of the Point of Interest.
`group_id` - `String`	ID of the group.

Example

Query

mutation Subscribe_group_poi(
  $poi_id: String,
  $group_id: String
) {
  subscribe_group_poi(
    poi_id: $poi_id,
    group_id: $group_id
  ) {
    status
  }
}

Variables

{
  "poi_id": "abc123",
  "group_id": "abc123"
}

Response

{"data": {"subscribe_group_poi": {"status": true}}}

Mutations

`take_iql_offer`

Description

Take an IQL offer.

Response

Returns a TakeIQLOffer

Arguments

Name	Description
`campaign_id` - `String`
`carrier_id` - `String`

Example

Query

mutation Take_iql_offer(
  $campaign_id: String,
  $carrier_id: String
) {
  take_iql_offer(
    campaign_id: $campaign_id,
    carrier_id: $carrier_id
  ) {
    success
  }
}

Variables

{
  "campaign_id": "xyz789",
  "carrier_id": "abc123"
}

Response

{"data": {"take_iql_offer": {"success": true}}}

Mutations

`unmake_group_admin`

Description

Mutation for unmaking a user an admin of a group.

Response

Returns an UnmakeUserEngagementGroupAdmin

Arguments

Name	Description
`group_id` - `String`	ID of the group.
`removed_admin_user_id` - `String`	Sentiance ID of the user to be removed as admin.

Example

Query

mutation Unmake_group_admin(
  $group_id: String,
  $removed_admin_user_id: String
) {
  unmake_group_admin(
    group_id: $group_id,
    removed_admin_user_id: $removed_admin_user_id
  ) {
    status
  }
}

Variables

{
  "group_id": "xyz789",
  "removed_admin_user_id": "abc123"
}

Response

{"data": {"unmake_group_admin": {"status": false}}}

Mutations

`unsubscribe_group_poi`

Description

Mutation for unsubscribing from a group POI.

Response

Returns an UnsubscribeUserEngagementGroupPoi

Arguments

Name	Description
`poi_id` - `String`	ID of the Point of Interest.
`group_id` - `String`	ID of the group.

Example

Query

mutation Unsubscribe_group_poi(
  $poi_id: String,
  $group_id: String
) {
  unsubscribe_group_poi(
    poi_id: $poi_id,
    group_id: $group_id
  ) {
    status
  }
}

Variables

{
  "poi_id": "abc123",
  "group_id": "xyz789"
}

Response

{"data": {"unsubscribe_group_poi": {"status": true}}}

Mutations

`update_feedback_event`

Description

Mutation for updating a feedback event.

Response

Returns an UpdateFeedbackEvent

Arguments

Name	Description
`actual_value` - `String`	Actual value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`expected_value` - `String`	Expected value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`event_id` - `String`	ID of the transport/event.
`meta_info` - `FeedbackEventMetaInfoInput`	Meta information for the feedback event. deprecated: use expected_value, actual_value instead.
`reason` - `String`	Reason feedback is provided.
`type` - `FeedbackTypeEnum`	Type of feedback.

Example

Query

mutation Update_feedback_event(
  $actual_value: String,
  $expected_value: String,
  $event_id: String,
  $meta_info: FeedbackEventMetaInfoInput,
  $reason: String,
  $type: FeedbackTypeEnum
) {
  update_feedback_event(
    actual_value: $actual_value,
    expected_value: $expected_value,
    event_id: $event_id,
    meta_info: $meta_info,
    reason: $reason,
    type: $type
  ) {
    feedback_event {
      actual_value
      expected_value
      event_id
      meta_info {
        ...FeedbackEventMetaInfoFragment
      }
      reason
      user_id
      created_at
      updated_at
      type
    }
  }
}

Variables

{
  "actual_value": "xyz789",
  "expected_value": "abc123",
  "event_id": "xyz789",
  "meta_info": FeedbackEventMetaInfoInput,
  "reason": "xyz789",
  "type": "FEEDBACK_TYPE_CRASH"
}

Response

{
  "data": {
    "update_feedback_event": {
      "feedback_event": FeedbackEvent
    }
  }
}

Mutations

`update_group`

Description

Mutation for updating a group.

Response

Returns an UpdateUserEngagementGroup

Arguments

Name	Description
`group_id` - `String`	ID of the group to update.
`name` - `String`	New name of the group. Has to non-empty, non-null string.

Example

Query

mutation Update_group(
  $group_id: String,
  $name: String
) {
  update_group(
    group_id: $group_id,
    name: $name
  ) {
    status
  }
}

Variables

{
  "group_id": "xyz789",
  "name": "abc123"
}

Response

{"data": {"update_group": {"status": false}}}

Types

AbandonUserEngagementChallenge

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

AcceleratingEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the acceleration event in seconds.
`magnitude` - `Float`	Max magnitude of the acceleration, measured in m/s².
`path` - `[PathElement]`	Path (waypoints) of the acceleration event while it lasted.
`end_at` - `String`	The end time of the acceleration event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the acceleration event (e.g. acceleration).
`mean` - `Float`	The mean of the acceleration event (e.g. acceleration).
`start_at` - `String`	The start time of the acceleration event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the acceleration event (e.g. brake, acceleration).

Example

{
  "duration": 123.45,
  "magnitude": 123.45,
  "path": [PathElement],
  "end_at": "xyz789",
  "category": "abc123",
  "mean": 123.45,
  "start_at": "abc123",
  "type": "xyz789"
}

Types

AcceptUserEngagementChallenge

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

AdditionalMobilityDetails

Fields

Field Name	Description
`raw_data_points` - `RawDataPoints`

Example

{"raw_data_points": RawDataPoints}

Types

AggregationFunctionEnum

Values

Enum Value	Description
`AVG`
`COUNT`
`MAX`
`MIN`
`SUM`

Example

"AVG"

Types

ApproveUserEngagementJoin

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

BrakingEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the braking event in seconds.
`magnitude` - `Float`	Max magnitude of the braking, measured in m/s².
`path` - `[PathElement]`	Path (waypoints) of the braking event while it lasted.
`end_at` - `String`	The end time of the braking event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the braking event.
`mean` - `Float`	The mean of the braking event (e.g. braking).
`start_at` - `String`	The start time of the braking event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the braking event.

Example

{
  "duration": 987.65,
  "magnitude": 123.45,
  "path": [PathElement],
  "end_at": "abc123",
  "category": "abc123",
  "mean": 123.45,
  "start_at": "abc123",
  "type": "xyz789"
}

Types

CallEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the call event in seconds.
`path` - `[PathElement]`	Path (waypoints) of the call event while it lasted.
`end_at` - `String`	The end time of the call event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the call event.
`speed` - `PhoneEventSpeed`	The speed during the call event.
`start_at` - `String`	The start time of the call event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the call event.

Example

{
  "duration": 987.65,
  "path": [PathElement],
  "end_at": "abc123",
  "category": "abc123",
  "speed": PhoneEventSpeed,
  "start_at": "xyz789",
  "type": "abc123"
}

Types

CheckIQLPermittedStatus

Fields

Field Name	Description
`permitted` - `Boolean`

Example

{"permitted": true}

Types

ComparisonOperatorEnum

Values

Enum Value	Description
`EQ`
`GT`
`GTE`
`IN`
`LT`
`LTE`
`NEQ`

Example

"EQ"

Types

Context

Types

Union Types
`IQLAbandonedUserStateContext`
`IQLNotPermittedUserStateContext`
`IQLOfferTakenUserStateContext`
`IQLQualifyUserStateContext`
`IQLRemovedPermissionsUserStateContext`
`IQLTestDriveStartedUserStateContext`

Example

IQLAbandonedUserStateContext

Types

CrashEvent

Fields

Field Name	Description
`confidence` - `Float`	confidence
`delta_v` - `Float`	delta v
`waypoint_direction` - `Float`	direction of the last waypoint
`waypoint_elevation` - `Float`	elevation of the last waypoint
`event_time` - `String`	exact moment of the crash event
`waypoint_horizontal_accuracy` - `Float`	horizontal accuracy of the last waypoint
`waypoint_latitude` - `Float`	latitude of the last waypoint
`waypoint_longitude` - `Float`	longitude of the last waypoint
`max_magnitude` - `Float`	max magnitude
`origin` - `String`	origin of the crash event
`severity` - `String`	severity of the crash event
`speed_at_impact` - `Float`	speed at impact
`waypoint_speed` - `Float`	speed of the last waypoint
`waypoint_time` - `String`	time of the last waypoint
`waypoint_vertical_accuracy` - `Float`	vertical accuracy of the last waypoint

Example

{
  "confidence": 123.45,
  "delta_v": 123.45,
  "waypoint_direction": 123.45,
  "waypoint_elevation": 987.65,
  "event_time": "abc123",
  "waypoint_horizontal_accuracy": 987.65,
  "waypoint_latitude": 123.45,
  "waypoint_longitude": 123.45,
  "max_magnitude": 987.65,
  "origin": "abc123",
  "severity": "xyz789",
  "speed_at_impact": 123.45,
  "waypoint_speed": 123.45,
  "waypoint_time": "xyz789",
  "waypoint_vertical_accuracy": 987.65
}

Types

CrashEventsForTransport

Fields

Field Name	Description
`crash_event` - `CrashEvent`	List of crash events in this transport.

Example

{"crash_event": CrashEvent}

Types

CreateFakeTransport

Fields

Field Name	Description
`transport_id` - `String`	ID of the created transport. If id is missing or empty string, it means that the transport was not created.

Example

{"transport_id": "abc123"}

Types

CreateFakeTransportRequest_SafetyScoresInput

Fields

Input Field	Description
`call_while_moving` - `Float`
`focus` - `Float`
`legal` - `Float`
`overall_safety` - `Float`
`smooth` - `Float`

Example

{
  "call_while_moving": 123.45,
  "focus": 987.65,
  "legal": 987.65,
  "overall_safety": 123.45,
  "smooth": 123.45
}

Types

CreateFakeTransportRequest_TransportModeEnum

Values

Enum Value	Description
`BICYCLE`
`BUS`
`CAR`
`MOTORCYCLE`
`RUNNING`
`TRAIN`
`TRAM`
`UNKNOWN`
`WALKING`

Example

"BICYCLE"

Types

CreateFeedbackEvent

Fields

Field Name	Description
`feedback_event` - `FeedbackEvent`	Feedback event created.

Example

{"feedback_event": FeedbackEvent}

Types

CreateUserEngagementGroup

Fields

Field Name	Description
`group` - `UserEngagementGroup`	Details of the newly created group.
`status` - `Boolean`	Success/Failure status.

Example

{"group": UserEngagementGroup, "status": false}

Types

CreateUserEngagementGroupPoi

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

CreateUserEngagementGroupRequest_UserEngagementGroupFeaturesInput

Fields

Input Field	Description
`with_feed` - `Boolean`
`with_leaderboard` - `Boolean`
`with_locations` - `Boolean`
`with_poi` - `Boolean`

Example

{
  "with_feed": true,
  "with_leaderboard": false,
  "with_locations": false,
  "with_poi": true
}

Types

CustomOffload

Fields

Field Name	Description
`day` - `String`
`files` - `[OffloadFile]`
`id` - `String`
`name` - `String`

Example

{
  "day": "xyz789",
  "files": [OffloadFile],
  "id": "xyz789",
  "name": "xyz789"
}

Types

DailyAvgScores

Fields

Field Name	Description
`slice` - `[DailyAvgScores_SliceEntry]`	Map from date to scores. Day is in yyyy-MM-dd format

Example

{"slice": [DailyAvgScores_SliceEntry]}

Types

DailyAvgScores_SliceEntry

Fields

Field Name	Description
`key` - `String`
`value` - `EngagementScores`

Example

{
  "key": "xyz789",
  "value": EngagementScores
}

Types

DeclineUserEngagementJoin

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

DeleteFeedbackEvent

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

DeleteUserById

Fields

Field Name	Description
`request_id` - `String`	Id of the unique user deletion request generated on our backend. Exists for debugging purposes. If you face any issues with user deletion, you can include this requestID in the support email to support@sentiance.com

Example

{"request_id": "xyz789"}

Types

DeleteUserEngagementGroup

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

DeleteUserEngagementGroupPoi

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

Diagnostics

Fields

Field Name	Description
`off_the_grids` - `[OffTheGrid]`
Arguments `from` - `String` The starting date for the search query in YYYY-MM-DD format (inclusive). `to` - `String` The starting date for the search query in YYYY-MM-DD format (inclusive).

Example

{"off_the_grids": [OffTheGrid]}

Types

Engagement

Fields

Field Name	Description
`group` - `UserEngagementGroup`	Group details.
Arguments `group_id` - `String` ID of the group. `reg_code` - `String` Registration code of the group.

Example

{"group": UserEngagementGroup}

Types

EngagementComparisonAttributeEnum

Values

Enum Value	Description
`ATTENTION_SCORE`
`CALL_EVENTS_COUNT`
`CALL_EVENTS_DURATION`
`CALL_WHILE_MOVING_SCORE`
`DISTANCE`
`DURATION`
`FOCUS_SCORE`
`HARSH_MOVEMENT_SCORE`
`LEGAL_SCORE`
`MFFS_SCORE`
`OCCUPANT_ROLE`
`OVERALL_SCORE`
`PHONE_HANDLING_EVENTS_COUNT`
`PHONE_HANDLING_EVENTS_DURATION`
`SCREEN_EVENTS_COUNT`
`SCREEN_EVENTS_DURATION`
`SMOOTH_SCORE`
`TRANSPORT_MODE`

Example

"ATTENTION_SCORE"

Types

EngagementCoordinates

Fields

Field Name	Description
`latitude` - `Float`	The latitude of the location.
`longitude` - `Float`	The longitude of the location.
`timestamp` - `Float`	The timestamp of the location if applicable.

Example

{"latitude": 123.45, "longitude": 123.45, "timestamp": 987.65}

Types

EngagementCoordinatesInput

Fields

Input Field	Description
`latitude` - `Float`
`longitude` - `Float`
`timestamp` - `Float`

Example

{"latitude": 987.65, "longitude": 987.65, "timestamp": 987.65}

Types

EngagementLocation

Fields

Field Name	Description
`city` - `String`	City of the location.
`country` - `String`	Country of the location.
`district` - `String`	District of the location.
`region` - `String`	Region of the location
`street` - `String`	Street of the location.

Example

{
  "city": "abc123",
  "country": "xyz789",
  "district": "abc123",
  "region": "xyz789",
  "street": "xyz789"
}

Types

EngagementLocationInput

Fields

Input Field	Description
`city` - `String`
`country` - `String`
`district` - `String`
`region` - `String`
`street` - `String`

Example

{
  "city": "abc123",
  "country": "abc123",
  "district": "xyz789",
  "region": "abc123",
  "street": "xyz789"
}

Types

EngagementPOI

Fields

Field Name	Description
`coordinates` - `EngagementCoordinates`	Coordinates of the Point of Interest.
`address` - `EngagementLocation`	Location of the Point of Interest.
`name` - `String`	Name of the Point of Interest.
`radius` - `Int`	Radius of the Point of Interest. Default 20 meters.

Example

{
  "coordinates": EngagementCoordinates,
  "address": EngagementLocation,
  "name": "abc123",
  "radius": 123
}

Types

EngagementPOIInput

Fields

Input Field	Description
`address` - `EngagementLocationInput`
`coordinates` - `EngagementCoordinatesInput`
`name` - `String`
`radius` - `Int`

Example

{
  "address": EngagementLocationInput,
  "coordinates": EngagementCoordinatesInput,
  "name": "abc123",
  "radius": 987
}

Types

EngagementScore

Fields

Field Name	Description
`name` - `EngagementScore_ScoreTypeEnum`	Score name.
`value` - `Float`	Score value.

Example

{"name": "ATTENTION_SCORE", "value": 987.65}

Types

EngagementScore_ScoreTypeEnum

Values

Enum Value	Description
`ATTENTION_SCORE`
`CALL_WHILE_MOVING_SCORE`
`FOCUS_SCORE`
`HARSH_MOVEMENT_SCORE`
`LEGAL_SCORE`
`MFFS_SCORE`
`OVERALL_SCORE`
`SMOOTH_SCORE`
`UNKNOWN`

Example

"ATTENTION_SCORE"

Types

EngagementScores

Fields

Field Name	Description
`slice` - `[EngagementScore]`	List containing scores available for you integration with Sentiance

Example

{"slice": [EngagementScore]}

Types

EngagementStreakThresholds

Fields

Field Name	Description
`slice` - `[EngagementScore]`	List containing streak thresholds for each score. Available scores are: OVERALL_SCORE, MFFS_SCORE, ATTENTION_SCORE, HARSH_MOVEMENT_SCORE, FOCUS_SCORE, CALL_WHILE_MOVING_SCORE, LEGAL_SCORE, depending on your integration with Sentiance.

Example

{"slice": [EngagementScore]}

Types

EngagementTransportEvent

Fields

Field Name	Description
`name` - `EngagementTransportEvent_TransportEventTypeEnum`	Transport event name.
`value` - `Float`	Transport event value.

Example

{"name": "CALL_EVENTS_COUNT", "value": 987.65}

Types

EngagementTransportEvent_TransportEventTypeEnum

Values

Enum Value	Description
`CALL_EVENTS_COUNT`
`CALL_EVENTS_DURATION`
`PHONE_HANDLING_EVENTS_COUNT`
`PHONE_HANDLING_EVENTS_DURATION`
`SCREEN_EVENTS_COUNT`
`SCREEN_EVENTS_DURATION`
`UNKNOWN`

Example

"CALL_EVENTS_COUNT"

Types

EngagementTrend

Fields

Field Name	Description
`end_datetime` - `String`	End datetime of the trend in ISO 8601 format.
`start_datetime` - `String`	Start datetime of the trend in ISO 8601 format.
`trend` - `Float`	Trend in percentages.

Example

{
  "end_datetime": "xyz789",
  "start_datetime": "xyz789",
  "trend": 987.65
}

Types

FeedbackEvent

Fields

Field Name	Description
`actual_value` - `String`	Actual value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`expected_value` - `String`	Expected value of the feedback event. eg:- transport mode 'CAR', crash event 'TRUE' or 'FALSE', occupant role 'DRIVER' or 'PASSENGER'.
`event_id` - `String`	ID of the transport/event.
`meta_info` - `FeedbackEventMetaInfo`	Meta information for the feedback event. deprecated: use expected_value, actual_value instead.
`reason` - `String`	Reason feedback is provided.
`user_id` - `String`	Sentiance User Id of the Feedback event.
`created_at` - `String`	Time when the feedback event was created.
`updated_at` - `String`	Time when the feedback event was last updated.
`type` - `FeedbackTypeEnum`	Type of feedback.

Example

{
  "actual_value": "xyz789",
  "expected_value": "abc123",
  "event_id": "abc123",
  "meta_info": FeedbackEventMetaInfo,
  "reason": "xyz789",
  "user_id": "xyz789",
  "created_at": "xyz789",
  "updated_at": "abc123",
  "type": "FEEDBACK_TYPE_CRASH"
}

Types

FeedbackEventMetaInfo

Fields

Field Name	Description
`is_false_positive_crash` - `Boolean`	Crash event detected is false positive. Use when FeedbackType is CRASH.
`has_user_marked_as_crash` - `Boolean`	Crash event marked as crashed by user. Use when FeedbackType is CRASH.
`has_sdk_marked_as_crash` - `Boolean`	Crash event marked crash by the SDK. Use when FeedbackType is CRASH.
`original_mode` - `String`	Original transport mode. Use when FeedbackType is TRANSPORT_MODE.
`recommended_mode` - `String`	Recomended transport mode. Use when FeedbackType is TRANSPORT_MODE.

Example

{
  "is_false_positive_crash": true,
  "has_user_marked_as_crash": false,
  "has_sdk_marked_as_crash": false,
  "original_mode": "xyz789",
  "recommended_mode": "xyz789"
}

Types

FeedbackEventMetaInfoInput

Fields

Input Field	Description
`has_sdk_marked_as_crash` - `Boolean`
`has_user_marked_as_crash` - `Boolean`
`is_false_positive_crash` - `Boolean`
`original_mode` - `String`
`recommended_mode` - `String`

Example

{
  "has_sdk_marked_as_crash": false,
  "has_user_marked_as_crash": true,
  "is_false_positive_crash": true,
  "original_mode": "xyz789",
  "recommended_mode": "xyz789"
}

Types

FeedbackTypeEnum

Values

Enum Value	Description
`FEEDBACK_TYPE_CRASH`
`FEEDBACK_TYPE_OCCUPANT_ROLE`
`FEEDBACK_TYPE_TRANSPORT_MODE`
`FEEDBACK_TYPE_UNKNOWN`

Example

"FEEDBACK_TYPE_CRASH"

Types

FilterInput

Fields

Input Field	Description
`attribute` - `EngagementComparisonAttributeEnum`
`operator` - `ComparisonOperatorEnum`
`value` - `String`

Example

{
  "attribute": "ATTENTION_SCORE",
  "operator": "EQ",
  "value": "abc123"
}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

Types

GenerateAuthCode

Fields

Field Name	Description
`authentication_code` - `String`
`expires_at` - `String`	Time in ISO-8601 format at which the authentication code expires.

Example

{
  "authentication_code": "abc123",
  "expires_at": "xyz789"
}

Types

GenerateCustomOffloadsUrl

Fields

Field Name	Description
`offload` - `CustomOffload`

Example

{"offload": CustomOffload}

Types

GenerateUrl

Fields

Field Name	Description
`offload` - `Offload`

Example

{"offload": Offload}

Types

IQL

Fields

Field Name	Description
`carriers` - `IQLCarriers`	Carriers available for the IQL program.
`disclaimer_text` - `IQLDisclaimerText`	Disclaimer text for the IQL program.
`region` - `String`	Returns the region associated with a zipcode.
Arguments `zipcode` - `String`

Example

{
  "carriers": IQLCarriers,
  "disclaimer_text": IQLDisclaimerText,
  "region": "abc123"
}

Types

IQLAbandonedUserStateContext

Fields

Field Name	Description
`abandon_type` - `IQLAbandonedUserStateContext_IQLAbandonTypeEnum`
`abandoned_at` - `Float`
`abandoned_at_iso` - `String`
`aggregator_offer` - `IQLAggregator`
`can_restart_program_in_ms` - `Float`
`started_at` - `Float`
`started_at_iso` - `String`

Example

{
  "abandon_type": "IQL_ABANDON_TYPE_NEVER_ELIGIBLE",
  "abandoned_at": 123.45,
  "abandoned_at_iso": "xyz789",
  "aggregator_offer": IQLAggregator,
  "can_restart_program_in_ms": 987.65,
  "started_at": 123.45,
  "started_at_iso": "xyz789"
}

Types

IQLAbandonedUserStateContext_IQLAbandonTypeEnum

Values

Enum Value	Description
`IQL_ABANDON_TYPE_NEVER_ELIGIBLE`
`IQL_ABANDON_TYPE_NEVER_QUALIFIED`
`IQL_ABANDON_TYPE_REMOVED_PERMISSIONS`
`IQL_ABANDON_TYPE_STALE_QUALIFIED`
`IQL_ABANDON_TYPE_UNKNOWN`
`IQL_ABANDON_TYPE_VOLUNTARY`
`IQL_ABANDON_TYPE_VOLUNTARY_NO_OFFER`

Example

"IQL_ABANDON_TYPE_NEVER_ELIGIBLE"

Types

IQLAggregator

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`url` - `String`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "url": "abc123"
}

Types

IQLCarrier

Fields

Field Name	Description
`campaigns` - `[IQLCarrier_IQLCampaign]`
`id` - `String`
`name` - `String`

Example

{
  "campaigns": [IQLCarrier_IQLCampaign],
  "id": "abc123",
  "name": "xyz789"
}

Types

IQLCarrierCampaign

Fields

Field Name	Description
`campaign_id` - `String`
`campaign_name` - `String`
`id` - `String`
`name` - `String`
`logo_url` - `String`	URL of the logo.

Example

{
  "campaign_id": "xyz789",
  "campaign_name": "abc123",
  "id": "xyz789",
  "name": "abc123",
  "logo_url": "abc123"
}

Types

IQLCarrierIntegration

Fields

Field Name	Description
`headers` - `[IQLCarrierIntegrationResponse_HeadersEntry]`
`http_verb` - `String`
`integration_type` - `IQLCarrierIntegrationTypeEnum`
`optional_payload_params` - `[String]`
`optional_query_params` - `[String]`
`required_payload_params` - `[String]`
`required_query_params` - `[String]`
`url` - `String`

Example

{
  "headers": [IQLCarrierIntegrationResponse_HeadersEntry],
  "http_verb": "xyz789",
  "integration_type": "IQL_CARRIER_INTEGRATION_HTML_PAGE",
  "optional_payload_params": ["xyz789"],
  "optional_query_params": ["xyz789"],
  "required_payload_params": ["abc123"],
  "required_query_params": ["abc123"],
  "url": "abc123"
}

Types

IQLCarrierIntegrationResponse_HeadersEntry

Fields

Field Name	Description
`key` - `String`
`value` - `String`

Example

{
  "key": "abc123",
  "value": "xyz789"
}

Types

IQLCarrierIntegrationTypeEnum

Values

Enum Value	Description
`IQL_CARRIER_INTEGRATION_HTML_PAGE`
`IQL_CARRIER_INTEGRATION_REDIRECT`
`IQL_CARRIER_INTEGRATION_UNKNOWN`

Example

"IQL_CARRIER_INTEGRATION_HTML_PAGE"

Types

IQLCarrier_IQLCampaign

Fields

Field Name	Description
`id` - `String`
`name` - `String`

Example

{
  "id": "abc123",
  "name": "xyz789"
}

Types

IQLCarriers

Fields

Field Name	Description
`slice` - `[IQLCarrier]`

Example

{"slice": [IQLCarrier]}

Types

IQLDisclaimerText

Fields

Field Name	Description
`informative_text` - `TemplatedText`	Informative text for Activate button.
`first_tick_box_text` - `TemplatedText`	Text for the first tick box.
`second_tick_box_text` - `TemplatedText`	Text for the second tick box.
`version` - `String`	Version of the disclaimer text.

Example

{
  "informative_text": TemplatedText,
  "first_tick_box_text": TemplatedText,
  "second_tick_box_text": TemplatedText,
  "version": "xyz789"
}

Types

IQLNotPermittedUserStateContext

Fields

Field Name	Description
`aggregator_offer` - `IQLAggregator`
`can_restart_program_in_ms` - `Float`
`checked_at` - `Float`
`checked_at_iso` - `String`
`region` - `String`

Example

{
  "aggregator_offer": IQLAggregator,
  "can_restart_program_in_ms": 987.65,
  "checked_at": 987.65,
  "checked_at_iso": "xyz789",
  "region": "xyz789"
}

Types

IQLOfferTakenUserStateContext

Fields

Field Name	Description
`can_restart_program_in_ms` - `Float`
`carrier_campaign` - `IQLCarrierCampaign`
`started_at` - `Float`
`started_at_iso` - `String`
`taken_at` - `Float`
`taken_at_iso` - `String`

Example

{
  "can_restart_program_in_ms": 123.45,
  "carrier_campaign": IQLCarrierCampaign,
  "started_at": 987.65,
  "started_at_iso": "abc123",
  "taken_at": 987.65,
  "taken_at_iso": "xyz789"
}

Types

IQLQualifyUserStateContext

Fields

Field Name	Description
`active_days` - `Int`
`carrier_campaign` - `IQLCarrierCampaign`
`distance_meters` - `Float`
`duration_minutes` - `Float`
`overall_user_score` - `Float`
`progress` - `Float`
`qualified_at` - `Float`
`qualified_at_iso` - `String`
`region` - `String`
`started_at` - `Float`
`started_at_iso` - `String`
`total_trips` - `Int`
`zipcode` - `String`
`carrier_integration` - `IQLCarrierIntegration`	Carrier integration information.
`trips` - `IQLUserTrips`	List of trips for the user.

Example

{
  "active_days": 123,
  "carrier_campaign": IQLCarrierCampaign,
  "distance_meters": 987.65,
  "duration_minutes": 987.65,
  "overall_user_score": 987.65,
  "progress": 987.65,
  "qualified_at": 987.65,
  "qualified_at_iso": "xyz789",
  "region": "abc123",
  "started_at": 123.45,
  "started_at_iso": "xyz789",
  "total_trips": 987,
  "zipcode": "abc123",
  "carrier_integration": IQLCarrierIntegration,
  "trips": IQLUserTrips
}

Types

IQLRemovedPermissionsUserStateContext

Fields

Field Name	Description
`active_days` - `Int`
`detected_at` - `Float`
`detected_at_iso` - `String`
`distance_meters` - `Float`
`duration_minutes` - `Float`
`overall_user_score` - `Float`
`progress` - `Float`
`started_at` - `Float`
`started_at_iso` - `String`
`total_trips` - `Int`
`trips` - `IQLUserTrips`	List of trips for the user.

Example

{
  "active_days": 987,
  "detected_at": 123.45,
  "detected_at_iso": "abc123",
  "distance_meters": 123.45,
  "duration_minutes": 987.65,
  "overall_user_score": 987.65,
  "progress": 987.65,
  "started_at": 123.45,
  "started_at_iso": "abc123",
  "total_trips": 123,
  "trips": IQLUserTrips
}

Types

IQLTestDriveStartedUserStateContext

Fields

Field Name	Description
`active_days` - `Int`
`distance_meters` - `Float`
`duration_minutes` - `Float`
`overall_user_score` - `Float`
`progress` - `Float`
`region` - `String`
`started_at` - `Float`
`started_at_iso` - `String`
`total_trips` - `Int`
`trips` - `IQLUserTrips`	List of trips for the user.

Example

{
  "active_days": 123,
  "distance_meters": 123.45,
  "duration_minutes": 987.65,
  "overall_user_score": 987.65,
  "progress": 987.65,
  "region": "xyz789",
  "started_at": 987.65,
  "started_at_iso": "xyz789",
  "total_trips": 123,
  "trips": IQLUserTrips
}

Types

IQLTrip

Fields

Field Name	Description
`call_while_moving_score` - `Float`
`distance_meters` - `Float`
`duration_minutes` - `Float`
`end_time` - `Float`
`end_time_iso` - `String`
`event_id` - `String`
`focus_score` - `Float`
`legal_score` - `Float`
`mode` - `String`
`occupant_role` - `String`
`overall_score` - `Float`
`smooth_score` - `Float`
`start_time` - `Float`
`start_time_iso` - `String`

Example

{
  "call_while_moving_score": 987.65,
  "distance_meters": 123.45,
  "duration_minutes": 123.45,
  "end_time": 123.45,
  "end_time_iso": "xyz789",
  "event_id": "abc123",
  "focus_score": 123.45,
  "legal_score": 123.45,
  "mode": "xyz789",
  "occupant_role": "abc123",
  "overall_score": 123.45,
  "smooth_score": 987.65,
  "start_time": 987.65,
  "start_time_iso": "xyz789"
}

Types

IQLUser

Fields

Field Name	Description
`program_status` - `IQLUserState`	State of the user in the IQL program.

Example

{"program_status": IQLUserState}

Types

IQLUserState

Fields

Field Name	Description
`context` - `Context`
`current_state` - `IQLUserStateEnum`

Example

{
  "context": IQLAbandonedUserStateContext,
  "current_state": "IQL_ABANDONED_STATE"
}

Types

IQLUserStateEnum

Values

Enum Value	Description
`IQL_ABANDONED_STATE`
`IQL_NOT_PERMITTED_STATE`
`IQL_OFFER_TAKEN_STATE`
`IQL_QUALIFY_STATE`
`IQL_REMOVED_PERMISSIONS_STATE`
`IQL_TEST_DRIVE_STARTED_STATE`
`IQL_UNKNOWN_STATE`

Example

"IQL_ABANDONED_STATE"

Types

IQLUserTrips

Fields

Field Name	Description
`slice` - `[IQLTrip]`

Example

{"slice": [IQLTrip]}

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

JoinUserEngagementGroup

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

LeaveUserEngagementGroup

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

Link

Fields

Field Name	Description
`url` - `String`
`expires_at` - `String`	expires_at is an ISO 8601 date string with time including seconds.

Example

{
  "url": "abc123",
  "expires_at": "2023-09-12T12:25:33Z"
}

Types

LocationInformation

Fields

Field Name	Description
`city` - `String`	The city to which the location belongs.
`country` - `String`	The country to which the location belongs.
`district` - `String`	The district to which the location belongs.
`region` - `String`	The region to which the location belongs.
`street` - `String`	The street to which the location belongs.

Example

{
  "city": "abc123",
  "country": "abc123",
  "district": "xyz789",
  "region": "abc123",
  "street": "abc123"
}

Types

MakeUserEngagementGroupAdmin

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

MapMatchedWaypoint

Fields

Field Name	Description
`distance` - `Float`	The distance in meters between the current waypoint and the previous waypoint.
`speed` - `Float`	The speed in km/h at the moment the waypoint was mapped.
`speed_limit` - `Float`	The speed limit in km/h of the road where the waypoint was mapped.
`road_type` - `String`	The type of road in which the waypoint was mapped (e.g. motorway, pedestrian, highway, etc.).
`latitude` - `Float`	Waypoint latitude in degrees with accuracy of 5 decimals.
`longitude` - `Float`	Waypoint longitude in degrees with accuracy of 5 decimals.
`timestamp` - `String`	Waypoint timestamp in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

Example

{
  "distance": 987.65,
  "speed": 987.65,
  "speed_limit": 123.45,
  "road_type": "xyz789",
  "latitude": 987.65,
  "longitude": 123.45,
  "timestamp": "abc123"
}

Types

MountedEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the mounted phone event in seconds.
`end_at` - `String`	The end time of the mounted phone event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the mounted phone event.
`start_at` - `String`	The start time of the mounted phone event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the mounted phone event.

Example

{
  "duration": 123.45,
  "end_at": "abc123",
  "category": "abc123",
  "start_at": "xyz789",
  "type": "xyz789"
}

Types

OffTheGrid

Fields

Field Name	Description
`end_at` - `String`	The end time of the off-the-grid in ISO 8601 format (e.g. 2022-06-27T11:26:48.351+01:00).
`reason` - `OffTheGrid_OffTheGridReasonEnum`	The reason why the off-the-grid started (e.g. OFF_THE_GRID_LOCATION_PERMISSION).
`start_at` - `String`	The start time of the off-the-grid in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`off_the_grid_id` - `String`	Unique ID of the off-the-grid event.

Example

{
  "end_at": "abc123",
  "reason": "OFF_THE_GRID_AIRPLANE_MODE",
  "start_at": "xyz789",
  "off_the_grid_id": "abc123"
}

Types

OffTheGrid_OffTheGridReasonEnum

Values

Enum Value	Description
`OFF_THE_GRID_AIRPLANE_MODE`
`OFF_THE_GRID_BGACCESS_PERMISSION`
`OFF_THE_GRID_BG_DETECTIONS_NOT_ALLOWED`
`OFF_THE_GRID_BG_EXECUTION_RESTRICTED`
`OFF_THE_GRID_DISKUSAGE_PERMISSION`
`OFF_THE_GRID_DISK_QUOTA_EXCEEDED`
`OFF_THE_GRID_EXTERNAL_EVENT`
`OFF_THE_GRID_GEOFENCE_TRANSITION_TIMEOUT`
`OFF_THE_GRID_KILLSWITCH`
`OFF_THE_GRID_LOCATION_ACCESS_ALWAYS`
`OFF_THE_GRID_LOCATION_ACCURACY_REDUCED`
`OFF_THE_GRID_LOCATION_MODE_BATTERY_SAVING`
`OFF_THE_GRID_LOCATION_MODE_DEVICE_ONLY`
`OFF_THE_GRID_LOCATION_MODE_OFF`
`OFF_THE_GRID_LOCATION_PERMISSION`
`OFF_THE_GRID_MOTION_ACTIVITY_PERMISSION`
`OFF_THE_GRID_NETWORK_PERMISSION`
`OFF_THE_GRID_NO_LOCATION_FIXES`
`OFF_THE_GRID_OTHER`
`OFF_THE_GRID_OUTAGE`
`OFF_THE_GRID_PLAY_SERVICES`
`OFF_THE_GRID_SDK_NOT_RUNNING`

Example

"OFF_THE_GRID_AIRPLANE_MODE"

Types

Offload

Fields

Field Name	Description
`files` - `[OffloadFile]`
`type` - `OffloadTypeEnum`
`day` - `String`	Day must be in YYYY-MM-DD format.

Example

{
  "files": [OffloadFile],
  "type": "OFFLOAD_TYPE_APP_EVENTS",
  "day": "2023-03-04"
}

Types

OffloadFile

Fields

Field Name	Description
`link` - `Link`
`name` - `String`
`format` - `String`	File format of the offload file.
`size` - `Int`	Size of the offload file in bytes.

Example

{
  "link": Link,
  "name": "abc123",
  "format": "csv.gz",
  "size": 987
}

Types

OffloadTypeEnum

Values

Enum Value	Description
`OFFLOAD_TYPE_APP_EVENTS`
`OFFLOAD_TYPE_BADGES`
`OFFLOAD_TYPE_CHALLENGES`
`OFFLOAD_TYPE_COMMUNICATIONS`
`OFFLOAD_TYPE_CUSTOM_SCORES`
`OFFLOAD_TYPE_DAILY_LEADERBOARD`
`OFFLOAD_TYPE_DAILY_REWARDS`
`OFFLOAD_TYPE_DRIVER_PASSENGER`
`OFFLOAD_TYPE_DRIVING_EVENTS_ALL`
`OFFLOAD_TYPE_DRIVING_EVENTS_SIGNIFICANT`
`OFFLOAD_TYPE_FEEDBACK`
`OFFLOAD_TYPE_GROUPS`
`OFFLOAD_TYPE_GROUP_MEMBERS`
`OFFLOAD_TYPE_MONTHLY_LEADERBOARD`
`OFFLOAD_TYPE_OFF_THE_GRIDS`
`OFFLOAD_TYPE_PRIMARY_SAFETY_SCORES_TRANSPORT`
`OFFLOAD_TYPE_PRIMARY_SAFETY_SCORES_USER`
`OFFLOAD_TYPE_RAW_WAYPOINTS`
`OFFLOAD_TYPE_SECONDARY_SAFETY_SCORES_TRANSPORT`
`OFFLOAD_TYPE_SECONDARY_SAFETY_SCORES_USER`
`OFFLOAD_TYPE_STREAKS`
`OFFLOAD_TYPE_TRAJECTORIES`
`OFFLOAD_TYPE_TRANSPORTS`
`OFFLOAD_TYPE_UNKNOWN`
`OFFLOAD_TYPE_WEEKLY_LEADERBOARD`
`OFFLOAD_TYPE_YEARLY_LEADERBOARD`

Example

"OFFLOAD_TYPE_APP_EVENTS"

Types

OptOutOfIQLTestDrive

Fields

Field Name	Description
`success` - `Boolean`

Example

{"success": false}

Types

PathElement

Fields

Field Name	Description
`latitude` - `Float`	Location-fix latitude in degrees with accuracy of 5 decimals.
`longitude` - `Float`	Location-fix longitude in degrees with accuracy of 5 decimals.

Example

{"latitude": 987.65, "longitude": 123.45}

Types

PhoneEventSpeed

Fields

Field Name	Description
`max` - `Float`
`min` - `Float`

Example

{"max": 987.65, "min": 987.65}

Types

PhoneHandlingEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the phone handling event in seconds.
`path` - `[PathElement]`	Path (waypoints) of the phone handling event while it lasted.
`end_at` - `String`	The end time of the phone handling event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the phone handling event.
`speed` - `PhoneEventSpeed`	The speed during the phone handling event.
`start_at` - `String`	The start time of the phone handling event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the phone handling event.

Example

{
  "duration": 123.45,
  "path": [PathElement],
  "end_at": "xyz789",
  "category": "abc123",
  "speed": PhoneEventSpeed,
  "start_at": "xyz789",
  "type": "abc123"
}

Types

PrimarySafetyScores

Fields

Field Name	Description
`attention` - `Float`	A combined score of handheld calling, hands-free calling and handling without calling. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`overall` - `Float`	A combined score of the legal, smooth, and attention scores. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`legal` - `Float`	The legal driving score measures how well you adhere to speed limits. The higher your score, the more you respect the speed limits. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`smooth` - `Float`	The smooth driving score measures how smooth you drive. High accelerations, heavy braking and heavy turning result in a lower score. The use of coasting results in a higher score. Scores are normalized with respect to a wide population. The higher your score, the smoother you drive. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

Example

{"attention": 987.65, "overall": 987.65, "legal": 987.65, "smooth": 987.65}

Types

RawDataPoints

Fields

Field Name	Description
`raw_waypoints` - `[RawWaypoint]`	List of raw waypoints.
`distance` - `Float`	The total distance travelled in meters. Based on the Haversine distance
`top_speed` - `Float`	Top speed reached in the transport in km/h.

Example

{
  "raw_waypoints": [RawWaypoint],
  "distance": 123.45,
  "top_speed": 987.65
}

Types

RawWaypoint

Fields

Field Name	Description
`speed` - `Float`	The speed in m/s
`accuracy` - `Int`	Waypoint accuracy in meters.
`latitude` - `Float`	Waypoint latitude in degrees with accuracy of 5 decimals.
`longitude` - `Float`	Waypoint longitude in degrees with accuracy of 5 decimals.
`timestamp` - `String`	Waypoint timestamp in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

Example

{
  "speed": 123.45,
  "accuracy": 123,
  "latitude": 987.65,
  "longitude": 123.45,
  "timestamp": "abc123"
}

Types

RemoveUserEngagementGroupMembership

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

ScoresTrend

Fields

Field Name	Description
`slice` - `[ScoresTrend_SliceEntry]`	Scores name to trend mapping.

Example

{"slice": [ScoresTrend_SliceEntry]}

Types

ScoresTrend_SliceEntry

Fields

Field Name	Description
`key` - `String`
`value` - `EngagementTrend`

Example

{
  "key": "abc123",
  "value": EngagementTrend
}

Types

ScreenEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the phone screen event in seconds.
`end_at` - `String`	The end time of the phone screen event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the phone screen event.
`speed` - `PhoneEventSpeed`	The speed during the phone screen event.
`start_at` - `String`	The start time of the phone screen event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the phone screen event.

Example

{
  "duration": 123.45,
  "end_at": "xyz789",
  "category": "abc123",
  "speed": PhoneEventSpeed,
  "start_at": "abc123",
  "type": "abc123"
}

Types

SecondarySafetyScores

Fields

Field Name	Description
`harsh_acceleration` - `Float`	Measures how often you accelerate hard. Every hard acceleration will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`harsh_braking` - `Float`	Measures how often you need to brake hard. Every hard brake will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`harsh_turning` - `Float`	Measures how often you turn hard. Every hard turn will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`anticipation` - `Float`	The anticipative driving score measures how well you anticipate turns. Hard accelerations before or hard braking during a turn result in a lower score. The use of coasting results in a higher score. The higher your score, the more anticipative you drive. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`mounted` - `Float`	The proportion of time (percentage) the phone is mounted while driving. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`focus` - `Float`	The proportion of time (percentage) the user is focused while driving, being focused means: not using the phone, which is detected through phone handling. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`wrong_way_driving` - `Float`	The score represents wrong-way driving violations. A score below 1 indicates that the driver has driven against the legal traffic direction. If we did not obtain sufficient data, the value will be -1.
`harsh_events` - `Float`	This is a combination of hard_accel and hard_brake score. The hard brakes and accelerations are also normalized by the total number of events. When we do not have sufficient data this value will be -1.

Example

{
  "harsh_acceleration": 123.45,
  "harsh_braking": 123.45,
  "harsh_turning": 987.65,
  "anticipation": 987.65,
  "mounted": 987.65,
  "focus": 123.45,
  "wrong_way_driving": 987.65,
  "harsh_events": 123.45
}

Types

SetUserEngagementGroupStatus

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

SliceByEnum

Values

Enum Value	Description
`DAY`
`MONTH`
`WEEK`
`WEEK_SUNDAY`
`YEAR`

Example

"DAY"

Types

SpeedingEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the speeding event in seconds.
`speed_limits` - `[Int]`	List of speed limits in km/h corresponding to the waypoints in the path.
`speeds` - `[Float]`	List of speeds in km/h corresponding to the waypoints in the path.
`path` - `[PathElement]`	Path (waypoints) of the speeding event while it lasted.
`end_at` - `String`	The end time of the speeding event in ISO 8601 format (e.g. 2022-06-26T11:26:48.350+01:00).
`category` - `String`	The main category of the speeding event.
`start_at` - `String`	The start time of the speeding event in ISO 8601 format (e.g. 2022-06-26T11:26:48.350+01:00).
`type` - `String`	The sub type of the speeding event.

Example

{
  "duration": 123.45,
  "speed_limits": [987],
  "speeds": [123.45],
  "path": [PathElement],
  "end_at": "abc123",
  "category": "abc123",
  "start_at": "abc123",
  "type": "xyz789"
}

Types

StreakTypeEnum

Values

Enum Value	Description
`STREAK_TYPE_SELF_COMPETING`
`STREAK_TYPE_STRICT`
`STREAK_TYPE_UNKNOWN`

Example

"STREAK_TYPE_SELF_COMPETING"

Types

StreakVariantEnum

Values

Enum Value	Description
`STREAK_VARIANT_DAY`
`STREAK_VARIANT_TRIP`
`STREAK_VARIANT_UNKNOWN`

Example

"STREAK_VARIANT_DAY"

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

SubmitLogEvent

Fields

Field Name	Description
`message` - `String`	Success/Failure message.
`status` - `Boolean`	Success/Failure status.

Example

{"message": "abc123", "status": false}

Types

SubmitLogEventRequest_EventParamsEntryInput

Fields

Input Field	Description
`key` - `String!`
`value` - `String!`

Example

{
  "key": "abc123",
  "value": "xyz789"
}

Types

SubmitUserEngagementPreferences

Fields

Field Name	Description
`message` - `String`	Success/Failure message.
`status` - `Boolean`	Success/Failure status.

Example

{"message": "xyz789", "status": false}

Types

SubmitUserEngagementPreferencesRequest_GraceConfigInput

Fields

Input Field	Description
`enabled` - `Boolean`

Example

{"enabled": true}

Types

SubmitUserEngagementPreferencesRequest_LanguageConfigInput

Fields

Input Field	Description
`code` - `String`
`name` - `String`

Example

{
  "code": "xyz789",
  "name": "xyz789"
}

Types

SubscribeUserEngagementGroupPoi

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

TakeIQLOffer

Fields

Field Name	Description
`success` - `Boolean`

Example

{"success": true}

Types

TemplateTag

Fields

Field Name	Description
`text` - `String`	Label for the template tag.
`link` - `String`	Value for the template tag.

Example

{
  "text": "xyz789",
  "link": "xyz789"
}

Types

TemplatedText

Fields

Field Name	Description
`template_tags` - `[TemplatedText_TemplateTagsEntry]`	Template tags for the templated text.
`text` - `String`	Templated text.

Example

{
  "template_tags": [TemplatedText_TemplateTagsEntry],
  "text": "xyz789"
}

Types

TemplatedText_TemplateTagsEntry

Fields

Field Name	Description
`key` - `String`
`value` - `TemplateTag`

Example

{
  "key": "xyz789",
  "value": TemplateTag
}

Types

TimeFrame

Fields

Field Name	Description
`to` - `String`	End of the time frame in yyyy-MM-dd'T'HH:mm:ss format (e.g. 2024-03-31T23:59:59).
`from` - `String`	Start of the time frame in yyyy-MM-dd'T'HH:mm:ss format (e.g. 2024-03-31T23:59:59).
`timezone` - `String`	Timezone of the time frame in IANA timezone format (e.g. Europe/Brussels). Default is Etc/UTC

Example

{
  "to": "abc123",
  "from": "xyz789",
  "timezone": "abc123"
}

Types

TimeFrameInput

Fields

Input Field	Description
`from` - `String`
`timezone` - `String`
`to` - `String`

Example

{
  "from": "abc123",
  "timezone": "xyz789",
  "to": "abc123"
}

Types

Transport

Fields

Field Name	Description
`additional_mobility_details` - `AdditionalMobilityDetails`	Additional mobility insights of the transport.
`crash_events` - `CrashEventsForTransport`	Crash events for the transport
`end_at` - `String`	End time of the transport in ISO 8601 format (e.g. 2022-06-26T15:21:21.351+01:00).
`metadata` - `String`	JSON array of of key-value pairs with metadata sent by the client.
`start_at` - `String`	Start time of the transport in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`scores` - `TransportScores`	The driving scores assigned to the transport.
`occupant_role` - `String`	The occupant role information of the transport.
`trajectory` - `TransportTrajectory`	The trajectory details of the transport.
`mode` - `String`	The transport mode. Possible values are: [biking, bus, car, ferry, idle, insufficient_data, running, train, tram, unsupported_mode, walking].
`transport_id` - `String`	The unique ID of the transport.
`weather_data` - `TransportWeatherData`	The weather data at the origin and destination of the transport
`top_speed` - `Float`	Top speed reached in the transport in km/h.
`duration` - `Int`	Total duration of the transport in seconds.
`driving_events` - `TransportDrivingEvents`	The driving events detected in the transport (CAR only).
Arguments `show` - `TransportDrivingEventsRequest_DrivingEventsFilterEnum` Accepted values are ALL (obtain significant and non-significant driving events) or SIGNIFICANT (obtain only significant driving events).

Example

{
  "additional_mobility_details": AdditionalMobilityDetails,
  "crash_events": CrashEventsForTransport,
  "end_at": "xyz789",
  "metadata": "abc123",
  "start_at": "abc123",
  "scores": TransportScores,
  "occupant_role": "xyz789",
  "trajectory": TransportTrajectory,
  "mode": "abc123",
  "transport_id": "abc123",
  "weather_data": TransportWeatherData,
  "top_speed": 987.65,
  "duration": 123,
  "driving_events": TransportDrivingEvents
}

Types

TransportDrivingEvents

Fields

Field Name	Description
`accelerating` - `[AcceleratingEvent]`	List of accelerating events.
`braking` - `[BrakingEvent]`	List of braking events.
`calls` - `[CallEvent]`	List of call events.
`mounted` - `[MountedEvent]`	List of mounted events.
`phone_handling` - `[PhoneHandlingEvent]`	List of phone-handling events.
`screens` - `[ScreenEvent]`	List of screen events.
`speeding` - `[SpeedingEvent]`	List of speeding events.
`turning` - `[TurningEvent]`	List of turning events.
`wrong_way_events` - `[WrongWayEvent]`	List of wrong way events.

Example

{
  "accelerating": [AcceleratingEvent],
  "braking": [BrakingEvent],
  "calls": [CallEvent],
  "mounted": [MountedEvent],
  "phone_handling": [PhoneHandlingEvent],
  "screens": [ScreenEvent],
  "speeding": [SpeedingEvent],
  "turning": [TurningEvent],
  "wrong_way_events": [WrongWayEvent]
}

Types

TransportDrivingEventsRequest_DrivingEventsFilterEnum

Values

Enum Value	Description
`ALL`
`SIGNIFICANT`

Example

"ALL"

Types

TransportFeedback

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

TransportFeedbackRequest_ContextEntryInput

Fields

Input Field	Description
`key` - `String!`
`value` - `String!`

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

Types

TransportScores

Fields

Field Name	Description
`safety` - `TransportScoresSafety`

Example

{"safety": TransportScoresSafety}

Types

TransportScoresSafety

Fields

Field Name	Description
`primary` - `PrimarySafetyScores`	Primary driving safety scores assigned to the transport.
`secondary` - `SecondarySafetyScores`	Secondary driving safety scores assigned to the transport.
`unified` - `UnifiedSafetyScores`	Unified safety scores assigned to the transport.

Example

{
  "primary": PrimarySafetyScores,
  "secondary": SecondarySafetyScores,
  "unified": UnifiedSafetyScores
}

Types

TransportTrajectory

Fields

Field Name	Description
`end_location` - `LocationInformation`	Information about the ending location of the trajectory.
`start_location` - `LocationInformation`	Information about the starting location of the trajectory.
`polyline` - `String`	The encoded path using Google's Encoded Polyline Algorithm format.
`map_matched_waypoints` - `[MapMatchedWaypoint]`	The map-matched waypoints of the trajectory.
`distance` - `Float`	The total distance travelled in meters.
`top_speed` - `Float`	Top speed reached in the transport in km/h.

Example

{
  "end_location": LocationInformation,
  "start_location": LocationInformation,
  "polyline": "abc123",
  "map_matched_waypoints": [MapMatchedWaypoint],
  "distance": 123.45,
  "top_speed": 123.45
}

Types

TransportWeatherData

Fields

Field Name	Description
`weather_at_destination` - `WeatherData`	The weather data at the destination of the transport
`weather_at_origin` - `WeatherData`	The weather data at the origin of the transport

Example

{
  "weather_at_destination": WeatherData,
  "weather_at_origin": WeatherData
}

Types

TurningEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the turning event in seconds.
`magnitude` - `Float`	Max magnitude of the turning, measured in m/s².
`path` - `[PathElement]`	Path (waypoints) of the turning event while it lasted.
`end_at` - `String`	The end time of the turning event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the turning event (e.g. turning).
`start_at` - `String`	The start time of the turning event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the turning event (e.g. left turn, right turn).

Example

{
  "duration": 123.45,
  "magnitude": 987.65,
  "path": [PathElement],
  "end_at": "abc123",
  "category": "xyz789",
  "start_at": "abc123",
  "type": "xyz789"
}

Types

UnifiedSafetyScores

Fields

Field Name	Description
`overall` - `Float`	A combined score of the legal, smooth, and attentive scores. The exact definition could depend on your use-case. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`attentive` - `Float`	The attentive driving score measures how attentive you are to your surroundings (for example: are you distracted by a call or phone handling). The exact definition could depend on your use-case. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`legal` - `Float`	The legal driving score measures how well you adhere to legal conditions (for example: adhering to speed limits). The exact definition could depend on your use-case. Range: 0..1. If we did not obtain sufficient data, the value will be -1.
`smooth` - `Float`	The smooth driving score measures how smoothly you drive (for example: high accelerations, heavy braking and heavy turning could result in a lower score). The exact definition could depend on your use-case. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

Example

{"overall": 123.45, "attentive": 123.45, "legal": 987.65, "smooth": 987.65}

Types

UnmakeUserEngagementGroupAdmin

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

UnsubscribeUserEngagementGroupPoi

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": true}

Types

UpdateFeedbackEvent

Fields

Field Name	Description
`feedback_event` - `FeedbackEvent`	Feedback event updated.

Example

{"feedback_event": FeedbackEvent}

Types

UpdateUserEngagementGroup

Fields

Field Name	Description
`status` - `Boolean`	Success/Failure status.

Example

{"status": false}

Types

User

Fields

Field Name	Description
`app_id` - `String`	App ID to which the user belongs.
`created_at` - `String`	Date and time of user creation in the Sentiance platform in ISO 8601 format (e.g. 2022-06-26T11:26:48.000+00:00).
`diagnostics` - `Diagnostics`	Diagnostics API for user-related events and information.
`engagement` - `UserEngagement`	Engagement information e.g driver coaching score, streaks, challenges, etc.
`external_id` - `String`	ID of the user given by the client application (if present).
`iql` - `IQLUser`	IQL user data.
`user_id` - `String`	Sentiance ID of the user.
`scores` - `UserScores`	Time-aggregated driving scores of the user.
Arguments `by` - `String` Aggregate user scores by either DAY, WEEK, MONTH or QUARTER. `date` - `String` The date for which to aggregate scores in YYYY-MM-DD format. If DAY is used, the exact given date is used. If WEEK is used, the given date is backtracked to Monday. If MONTH is used, the given date is backtracked to the first day of the month. If QUARTER is used, the given date is backtracked to the first day of the quarter.
`feedback_events` - `[FeedbackEvent]`	Get feedback event(s) for a user.
Arguments `event_id` - `String` Filter for the ID of the transport/event. Only single event can be filtered. `type` - `FeedbackTypeEnum` Type of feedback.
`transports` - `[Transport]`	List of transports belonging to the user.
Arguments `from` - `String` The starting date for the search query in YYYY-MM-DD format (inclusive). `to` - `String` The starting date for the search query in YYYY-MM-DD format (inclusive).

Example

{
  "app_id": "xyz789",
  "created_at": "abc123",
  "diagnostics": Diagnostics,
  "engagement": UserEngagement,
  "external_id": "xyz789",
  "iql": IQLUser,
  "user_id": "abc123",
  "scores": UserScores,
  "feedback_events": [FeedbackEvent],
  "transports": [Transport]
}

Types

UserEngagement

Fields

Field Name	Description
`communications` - `UserEngagementCommunications`	Communications of a user.
`library` - `UserEngagementLibrary`	Engagement Content Library.
`badges` - `UserEngagementBadges`	Engagement user badges.
`challenges` - `UserEngagementChallenges`	Engagement user challenges.
`groups` - `UserEngagementGroups`	Engagement user groups.
Arguments `group_id` - `String` Filter for a specific group_id. Only one filter por request is allowed. `roles` - `[UserEngagementGroupRoleEnum]` Filter for groups where user has selected roles. Available options: ADMIN, MEMBER, PENDING. Not choosing any role will return all groups.
`transports` - `UserEngagementTransports`	Transports of the user.
Arguments `occupant_role` - `UserEngagementTransportsRequest_OccupantRoleEnum` Filter for occupant role of transports. Available options: ANY, DRIVER, PASSENGER, DRIVER_AND_PASSENGER and UNKNOWN. Default: ANY `mode` - `UserEngagementTransportsRequest_TransportModeEnum` Filter for transport mode. Available options: ANY_MODE, BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING, INSUFFICIENT_DATA, UNSUPPORTED_MODE, MOTORCYCLE. Default: CAR. `in_grace_period` - `UserEngagementTransportsRequest_InGracePeriodEnum` Filter for transports in grace period. Available options: ALL, TRUE, FALSE. Default: ALL. `limit` - `Int` Number of transports to return. `pagination_token` - `String` Pagination token.
`streaks` - `UserEngagementStreaks`	Engagement user streaks.
Arguments `transport_mode` - `UserEngagementScoresRequest_TransportModeEnum` Filter for transport mode. Available options: BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING. Default: CAR. `type` - `StreakTypeEnum` Filter for type of the streak. Available options: TRIP, DAY. Default: TRIP. `variant` - `StreakVariantEnum` Filter for variant of the streak. Available options: STRICT, SELF_COMPETING. Default: STRICT.
`scores` - `UserEngagementScores`	Engagement user scores.
Arguments `transport_mode` - `UserEngagementScoresRequest_TransportModeEnum` Filter for transport mode. Default: CAR.
`transport` - `UserEngagementTransport`	Transport of a user by ID.
Arguments `transport_id` - `String` ID of the transport.
`aggregations` - `UserEngagementAggregations`	Aggregations of a user.
Arguments `slice_by` - `SliceByEnum` Slice the aggregation by DAY, WEEK, MONTH or YEAR. If no option is provided, the aggregation will not be sliced and the aggregation for the entire period will pe returned. `time_frame` - `TimeFrameInput` Time frame for the aggregation. `function` - `AggregationFunctionEnum` Type of aggregation to perform. Default is AVG

Example

{
  "communications": UserEngagementCommunications,
  "library": UserEngagementLibrary,
  "badges": UserEngagementBadges,
  "challenges": UserEngagementChallenges,
  "groups": UserEngagementGroups,
  "transports": UserEngagementTransports,
  "streaks": UserEngagementStreaks,
  "scores": UserEngagementScores,
  "transport": UserEngagementTransport,
  "aggregations": UserEngagementAggregations
}

Types

UserEngagementAggregations

Fields

Field Name	Description
`daily_rewards` - `UserEngagementDailyRewardsAggregationsSlice`	Engagement user aggregated data for daily rewards.
`user_id` - `String`	Sentiance ID of the user.
`transports` - `UserEngagementTransportAggregationsSlice`	Engagement user aggregated data for transports.
Arguments `filters` - `[FilterInput]` Filters to apply before the aggregation is computed

Example

{
  "daily_rewards": UserEngagementDailyRewardsAggregationsSlice,
  "user_id": "xyz789",
  "transports": UserEngagementTransportAggregationsSlice
}

Types

UserEngagementBadge

Fields

Field Name	Description
`category` - `String`	Category of the badge.
`completed_at` - `String`	Completed time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`description` - `String`	Description of the badge.
`id` - `String`	ID of the badge.
`image_url` - `String`	Image URL of the badge.
`level` - `Int`	Level of the badge.
`name` - `String`	Name of the badge.
`progress` - `Int`	Progress of the badge.
`reward_text` - `String`	Reward text of the badge.
`started_at` - `String`	Start time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`status` - `String`	Status of the badge.
`updated_at` - `String`	Updated time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

Example

{
  "category": "xyz789",
  "completed_at": "abc123",
  "description": "xyz789",
  "id": "abc123",
  "image_url": "xyz789",
  "level": 987,
  "name": "abc123",
  "progress": 123,
  "reward_text": "abc123",
  "started_at": "abc123",
  "status": "abc123",
  "updated_at": "xyz789"
}

Types

UserEngagementBadges

Fields

Field Name	Description
`slice` - `[UserEngagementBadge]`	List of badges.

Example

{"slice": [UserEngagementBadge]}

Types

UserEngagementChallenge

Fields

Field Name	Description
`accepted_at` - `String`	Accepted time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	Category of the challenge.
`description` - `String`	Description of the challenge.
`difficulty` - `String`	Difficulty of the challenge.
`ended_at` - `String`	Ended time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`can_receive_feedback` - `Boolean`	Flag that marks the challenge as eligible for feedback.
`challenge_id` - `String`	ID of the challenge.
`image_url` - `String`	Image URL of the challenge.
`count` - `Int`	Order of the challenge by difficulty.
`ordering` - `Int`	Order of the challenge by subcategory.
`progress` - `Int`	Progress of the challenge.
`status` - `String`	Status of the challenge.
`new` - `String`	String that has value 'new' if this challenge has never been accepted by the user. Null otherwise.
`subcategory` - `String`	Subcategory of the challenge.
`updated_at` - `String`	Updated time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`id` - `String`	Use challenge_id instead.

Example

{
  "accepted_at": "xyz789",
  "category": "abc123",
  "description": "xyz789",
  "difficulty": "xyz789",
  "ended_at": "xyz789",
  "can_receive_feedback": true,
  "challenge_id": "xyz789",
  "image_url": "xyz789",
  "count": 123,
  "ordering": 987,
  "progress": 123,
  "status": "abc123",
  "new": "xyz789",
  "subcategory": "abc123",
  "updated_at": "xyz789",
  "id": "abc123"
}

Types

UserEngagementChallenges

Fields

Field Name	Description
`active` - `UserEngagementChallengesSlice`	Active Challenges of the user
`available` - `UserEngagementChallengesSlice`	Available Challenges of the user
`completed` - `UserEngagementChallengesSlice`	Completed Challenges of the user.

Example

{
  "active": UserEngagementChallengesSlice,
  "available": UserEngagementChallengesSlice,
  "completed": UserEngagementChallengesSlice
}

Types

UserEngagementChallengesSlice

Fields

Field Name	Description
`slice` - `[UserEngagementChallenge]`	List of challenges.

Example

{"slice": [UserEngagementChallenge]}

Types

UserEngagementCommunication

Fields

Field Name	Description
`button_label` - `String`	Button label text for communications that have a button.
`category` - `String`	Category of the communication.
`evaluation_id` - `String`	Evaluation ID of the communication.
`expires_at` - `String`	Expire time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`generated_at` - `String`	Generated time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`communication_id` - `String`	ID of the communication.
`context` - `[UserEngagementCommunicationResponse_ContextEntry]`	Map containing the context in which the communication was generated.
`message` - `String`	Message of the communication.
`priority` - `Int`	Priority of the communication.
`button_url` - `String`	Redirect url for communications that have a button.
`status` - `String`	Status of the communication.
`title` - `String`	Title of the communication.
`transport_mode` - `String`	Transport mode for communications that are related to a transport.
`type` - `String`	Type of the communication.
`updated_at` - `String`	Updated time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

Example

{
  "button_label": "abc123",
  "category": "abc123",
  "evaluation_id": "abc123",
  "expires_at": "xyz789",
  "generated_at": "abc123",
  "communication_id": "xyz789",
  "context": [
    UserEngagementCommunicationResponse_ContextEntry
  ],
  "message": "xyz789",
  "priority": 987,
  "button_url": "abc123",
  "status": "xyz789",
  "title": "xyz789",
  "transport_mode": "xyz789",
  "type": "xyz789",
  "updated_at": "xyz789"
}

Types

UserEngagementCommunicationResponse_ContextEntry

Fields

Field Name	Description
`key` - `String`
`value` - `String`

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

Types

UserEngagementCommunications

Fields

Field Name	Description
`all` - `UserEngagementCommunicationsSlice`	All Communications of the user
Arguments `category` - `UserEngagementCommunicationsRequest_CategoryEnum` Category of the communication. Available options: ALL, CHALLENGES, BADGES, STREAKS, SCORES, LEADERBOARD, TRIPS, PROFILE, SCHEDULED. `transport_mode` - `UserEngagementTransportsRequest_TransportModeEnum` Filter for transport mode. Available options: ANY_MODE, BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING, INSUFFICIENT_DATA, UNSUPPORTED_MODE, MOTORCYCLE. Default: CAR. `limit` - `Int` Number of communications to return. `type` - `UserEngagementCommunicationsRequest_TypeEnum` Type of the communication. Available options: IN_APP_MESSAGE, REACTIVE_MESSAGE.
`closed` - `UserEngagementCommunicationsSlice`	Closed Communications of the user
Arguments `category` - `UserEngagementCommunicationsRequest_CategoryEnum` Category of the communication. Available options: ALL, CHALLENGES, BADGES, STREAKS, SCORES, LEADERBOARD, TRIPS, PROFILE, SCHEDULED. `transport_mode` - `UserEngagementTransportsRequest_TransportModeEnum` Filter for transport mode. Available options: ANY_MODE, BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING, INSUFFICIENT_DATA, UNSUPPORTED_MODE, MOTORCYCLE. Default: CAR. `limit` - `Int` Number of communications to return. `type` - `UserEngagementCommunicationsRequest_TypeEnum` Type of the communication. Available options: IN_APP_MESSAGE, REACTIVE_MESSAGE.
`expired` - `UserEngagementCommunicationsSlice`	Expired Communications of the user
Arguments `category` - `UserEngagementCommunicationsRequest_CategoryEnum` Category of the communication. Available options: ALL, CHALLENGES, BADGES, STREAKS, SCORES, LEADERBOARD, TRIPS, PROFILE, SCHEDULED. `transport_mode` - `UserEngagementTransportsRequest_TransportModeEnum` Filter for transport mode. Available options: ANY_MODE, BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING, INSUFFICIENT_DATA, UNSUPPORTED_MODE, MOTORCYCLE. Default: CAR. `limit` - `Int` Number of communications to return. `type` - `UserEngagementCommunicationsRequest_TypeEnum` Type of the communication. Available options: IN_APP_MESSAGE, REACTIVE_MESSAGE.
`new` - `UserEngagementCommunicationsSlice`	New Communications of the user
Arguments `category` - `UserEngagementCommunicationsRequest_CategoryEnum` Category of the communication. Available options: ALL, CHALLENGES, BADGES, STREAKS, SCORES, LEADERBOARD, TRIPS, PROFILE, SCHEDULED. `transport_mode` - `UserEngagementTransportsRequest_TransportModeEnum` Filter for transport mode. Available options: ANY_MODE, BIKING, BUS, CAR, FERRY, IDLE, RUNNING, TRAIN, TRAM, WALKING, INSUFFICIENT_DATA, UNSUPPORTED_MODE, MOTORCYCLE. Default: CAR. `limit` - `Int` Number of communications to return. `type` - `UserEngagementCommunicationsRequest_TypeEnum` Type of the communication. Available options: IN_APP_MESSAGE, REACTIVE_MESSAGE.

Example

{
  "all": UserEngagementCommunicationsSlice,
  "closed": UserEngagementCommunicationsSlice,
  "expired": UserEngagementCommunicationsSlice,
  "new": UserEngagementCommunicationsSlice
}

Types

UserEngagementCommunicationsRequest_CategoryEnum

Values

Enum Value	Description
`ALL`
`BADGES`
`CHALLENGES`
`GROUPS`
`LEADERBOARD`
`PROFILE`
`SCHEDULED`
`SCORES`
`STREAKS`
`TRIPS`

Example

"ALL"

Types

UserEngagementCommunicationsRequest_TypeEnum

Values

Enum Value	Description
`IN_APP_MESSAGE`
`REACTIVE_MESSAGE`

Example

"IN_APP_MESSAGE"

Types

UserEngagementCommunicationsSlice

Fields

Field Name	Description
`slice` - `[UserEngagementCommunication]`	List of communications.

Example

{"slice": [UserEngagementCommunication]}

Types

UserEngagementCurrentPOI

Fields

Field Name	Description
`poi_id` - `String`	ID of the POI.
`poi_details` - `EngagementPOI`	POI details.
`entered_poi_at` - `Float`	Timestamp when the user entered the POI in epoch milliseconds.

Example

{
  "poi_id": "abc123",
  "poi_details": EngagementPOI,
  "entered_poi_at": 987.65
}

Types

UserEngagementDailyRewardsAggregations

Fields

Field Name	Description
`data` - `UserEngagementDailyRewardsAggregationsData`	Data that was aggregated.
`dimensions` - `UserEngagementDailyRewardsAggregationsDimensions`	Dimensions for the aggregation. All data is grouped by these dimensions except when it's not sliced
`metadata` - `UserEngagementDailyRewardsAggregationsMetadata`	Metadata for the aggregation.

Example

{
  "data": UserEngagementDailyRewardsAggregationsData,
  "dimensions": UserEngagementDailyRewardsAggregationsDimensions,
  "metadata": UserEngagementDailyRewardsAggregationsMetadata
}

Types

UserEngagementDailyRewardsAggregationsData

Fields

Field Name	Description
`points` - `Float`	Value of chosen aggregation type for points.

Example

{"points": 123.45}

Types

UserEngagementDailyRewardsAggregationsDimensions

Fields

Field Name	Description
`time_frame` - `TimeFrame`	Time frame for the aggregation.

Example

{"time_frame": TimeFrame}

Types

UserEngagementDailyRewardsAggregationsMetadata

Fields

Field Name	Description
`slice_by` - `SliceByEnum`	How data was sliced. Can be missing if the request didn't contain a slice_by field.
`function` - `AggregationFunctionEnum`	Type of aggregation performed.

Example

{"slice_by": "DAY", "function": "AVG"}

Types

UserEngagementDailyRewardsAggregationsSlice

Fields

Field Name	Description
`slice` - `[UserEngagementDailyRewardsAggregations]`	Slice of aggregated data for the user.

Example

{"slice": [UserEngagementDailyRewardsAggregations]}

Types

UserEngagementGroup

Fields

Field Name	Description
`created_at` - `Float`	Create time in epoch milliseconds.
`group_id` - `String`	ID of the group.
`members` - `UserEngagementGroupMembers`	Members of the group.
`name` - `String`	Name of the group.
`points_of_interest` - `UserEngagementGroupPois`	Points of interest of the group.
`reg_code` - `String`	Registration code of the group.
`feed` - `UserEngagementGroupFeed`	Events feed of the group.
Arguments `ranking_attribute` - `UserEngagementGroupRankingAttributeEnum` Ranking attribute to populate the group feed by. Available options: DRIVER_COACHING_SCORE. Options applicable depending on how the group was created.
`leaderboard` - `UserEngagementGroupLeaderboard`	Leaderboard of the group.
Arguments `ranking_attribute` - `UserEngagementGroupRankingAttributeEnum` Ranking attribute to populate the group leaderboard by. Available options: DRIVER_COACHING_SCORE.

Example

{
  "created_at": 987.65,
  "group_id": "abc123",
  "members": UserEngagementGroupMembers,
  "name": "xyz789",
  "points_of_interest": UserEngagementGroupPois,
  "reg_code": "xyz789",
  "feed": UserEngagementGroupFeed,
  "leaderboard": UserEngagementGroupLeaderboard
}

Types

UserEngagementGroupFeed

Fields

Field Name	Description
`group_id` - `String`	ID of the group.
`slice` - `[UserEngagementGroupFeedMessage]`	List of feed messages.

Example

{
  "group_id": "xyz789",
  "slice": [UserEngagementGroupFeedMessage]
}

Types

UserEngagementGroupFeedMessage

Fields

Field Name	Description
`params` - `[String]`	List of parameters to be replaced in the feed message.
`message` - `String`	Parameterised feed message.
`generated_at` - `String`	Time feed message was generated in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

Example

{
  "params": ["xyz789"],
  "message": "abc123",
  "generated_at": "xyz789"
}

Types

UserEngagementGroupLeaderboard

Fields

Field Name	Description
`group_id` - `String`	ID of the group.
`slice` - `[UserEngagementGroupLeaderboardMember]`	List of leaderboard members.

Example

{
  "group_id": "abc123",
  "slice": [UserEngagementGroupLeaderboardMember]
}

Types

UserEngagementGroupLeaderboardMember

Fields

Field Name	Description
`ranking_attr` - `String`	Attribute by which the leaderboard was ranked.
`user_id` - `String`	Sentiance ID of the user.
`rank` - `Int`	User's rank in the group's leaderboard.
`ranking_score` - `Float`	User's score in the group's leaderboard.

Example

{
  "ranking_attr": "xyz789",
  "user_id": "xyz789",
  "rank": 123,
  "ranking_score": 987.65
}

Types

UserEngagementGroupMember

Fields

Field Name	Description
`current_poi` - `UserEngagementCurrentPOI`	Current POI the user is inside.
`joined_at` - `Float`	Join timestamp in epoch milliseconds.
`last_known_location` - `EngagementCoordinates`	Last known location coordinates of the user.
`poi_subscriptions` - `[String]`	List of POIs the user is subscribed to.
`role` - `UserEngagementGroupRoleEnum`	Role of the user in the group.
`user_id` - `String`	Sentiance ID of the user.
`status` - `String`	Status of the user.
`status_expires_at` - `Float`	Timestamp when the status expires in epoch milliseconds.

Example

{
  "current_poi": UserEngagementCurrentPOI,
  "joined_at": 123.45,
  "last_known_location": EngagementCoordinates,
  "poi_subscriptions": ["xyz789"],
  "role": "ADMIN",
  "user_id": "abc123",
  "status": "xyz789",
  "status_expires_at": 123.45
}

Types

UserEngagementGroupMembers

Fields

Field Name	Description
`slice` - `[UserEngagementGroupMember]`	List of group members.

Example

{"slice": [UserEngagementGroupMember]}

Types

UserEngagementGroupPois

Fields

Field Name	Description
`group_id` - `String`	ID of the group.
`slice` - `[UserEngagementGroupPoisSlice]`	List of POIs.

Example

{
  "group_id": "abc123",
  "slice": [UserEngagementGroupPoisSlice]
}

Types

UserEngagementGroupPoisSlice

Fields

Field Name	Description
`poi_id` - `String`	ID of the POI.
`poi_details` - `EngagementPOI`	POI details.

Example

{
  "poi_id": "xyz789",
  "poi_details": EngagementPOI
}

Types

UserEngagementGroupRankingAttributeEnum

Values

Enum Value	Description
`DRIVER_COACHING_SCORE`

Example

"DRIVER_COACHING_SCORE"

Types

UserEngagementGroupRoleEnum

Values

Enum Value	Description
`ADMIN`
`MEMBER`
`PENDING`
`UNKNOWN`

Example

"ADMIN"

Types

UserEngagementGroupTypeEnum

Values

Enum Value	Description
`SOCIAL`

Example

"SOCIAL"

Types

UserEngagementGroups

Fields

Field Name	Description
`slice` - `[UserEngagementGroup]`	Groups of a user,
`user_id` - `String`	Sentiance ID of the user.

Example

{
  "slice": [UserEngagementGroup],
  "user_id": "xyz789"
}

Types

UserEngagementLibrary

Fields

Field Name	Description
`knowledge_bites` - `UserEngagementLibraryKnowledgeBites`	Engagement knowledge bytes.
`smart_tips` - `UserEngagementLibrarySmartTips`	Engagement smart tips.

Example

{
  "knowledge_bites": UserEngagementLibraryKnowledgeBites,
  "smart_tips": UserEngagementLibrarySmartTips
}

Types

UserEngagementLibraryItem

Fields

Field Name	Description
`category` - `String`	Category of library item.
`content` - `String`	Content of library item.
`created_at` - `String`	Created time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`content_extra` - `String`	Extra content of library item.
`item_id` - `String`	ID of library item.
`subcategory` - `String`	Subcategory of library item.
`title` - `String`	Title of library item.

Example

{
  "category": "abc123",
  "content": "xyz789",
  "created_at": "xyz789",
  "content_extra": "abc123",
  "item_id": "abc123",
  "subcategory": "xyz789",
  "title": "xyz789"
}

Types

UserEngagementLibraryKnowledgeBites

Fields

Field Name	Description
`slice` - `[UserEngagementLibraryItem]`	List of knowledge bytes.

Example

{"slice": [UserEngagementLibraryItem]}

Types

UserEngagementLibrarySmartTips

Fields

Field Name	Description
`slice` - `[UserEngagementLibraryItem]`	List of smart tips.

Example

{"slice": [UserEngagementLibraryItem]}

Types

UserEngagementScores

Fields

Field Name	Description
`slice` - `[EngagementScore]`	List containing scores. Available scores are: OVERALL_SCORE, MFFS_SCORE, ATTENTION_SCORE, HARSH_MOVEMENT_SCORE, FOCUS_SCORE, CALL_WHILE_MOVING_SCORE, LEGAL_SCORE, SMOOTH_SCORE depending on your integration with Sentiance.

Example

{"slice": [EngagementScore]}

Types

UserEngagementScoresRequest_TransportModeEnum

Values

Enum Value	Description
`BIKING`
`BUS`
`CAR`
`COMPOUND`
`FERRY`
`IDLE`
`MOTORCYCLE`
`RUNNING`
`TRAIN`
`TRAM`
`WALKING`

Example

"BIKING"

Types

UserEngagementStreaks

Fields

Field Name	Description
`best` - `UserEngagementStreaksCount`	Best streaks of the user
`current` - `UserEngagementStreaksCount`	Current streaks of the user.
`user_id` - `String`	Sentiance ID of the user.

Example

{
  "best": UserEngagementStreaksCount,
  "current": UserEngagementStreaksCount,
  "user_id": "xyz789"
}

Types

UserEngagementStreaksContext

Fields

Field Name	Description
`daily_avg_scores` - `DailyAvgScores`	Daily average scores, excluding today.
`streak_thresholds` - `EngagementStreakThresholds`	Streaks thresholds configuration.
`today_avg_scores` - `EngagementScores`	Today's average scores.
`scores_trend` - `ScoresTrend`	Trend of the scores.

Example

{
  "daily_avg_scores": DailyAvgScores,
  "streak_thresholds": EngagementStreakThresholds,
  "today_avg_scores": EngagementScores,
  "scores_trend": ScoresTrend
}

Types

UserEngagementStreaksCount

Fields

Field Name	Description
`context` - `UserEngagementStreaksContext`	Context around streaks. Values returned here depend on your integration with Sentiance.
`slice` - `[EngagementScore]`	List containing streaks for each score. Available scores are: OVERALL_SCORE, MFFS_SCORE, ATTENTION_SCORE, HARSH_MOVEMENT_SCORE, FOCUS_SCORE, CALL_WHILE_MOVING_SCORE, LEGAL_SCORE, SMOOTH_SCORE depending on your integration with Sentiance.

Example

{
  "context": UserEngagementStreaksContext,
  "slice": [EngagementScore]
}

Types

UserEngagementTransport

Fields

Field Name	Description
`created_at` - `String`	Create time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`end_at` - `String`	End time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`in_grace_period` - `Boolean`	Flag that marks the transport as inside of the grace period or outside of grace period. Always false if grace period not enabled for user.
`can_receive_feedback` - `Boolean`	Flag that marks the transport eligible to receive feedback.
`feedback_events` - `[FeedbackEvent]`	Get feedback event(s) for a user with given transport id.
`transport_id` - `String`	ID of the transport.
`mode` - `String`	Mode of transport.
`occupant_role` - `String`	Occupant role of the transport if mode is CAR.
`scores` - `UserEngagementTransportScores`	Scores for the transport.
`start_at` - `String`	Start time in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`duration` - `Float`	Total duration in minutes.
`trajectory` - `UserEngagementTransportTrajectory`	Trajectory of the transport.

Example

{
  "created_at": "abc123",
  "end_at": "abc123",
  "in_grace_period": true,
  "can_receive_feedback": true,
  "feedback_events": [FeedbackEvent],
  "transport_id": "abc123",
  "mode": "abc123",
  "occupant_role": "abc123",
  "scores": UserEngagementTransportScores,
  "start_at": "xyz789",
  "duration": 987.65,
  "trajectory": UserEngagementTransportTrajectory
}

Types

UserEngagementTransportAggregationsData

Fields

Field Name	Description
`events` - `UserEngagementTransportAggregationsData_UserEngagementTransportEventsAggregations`	Events for the aggregation. Only applicable for CAR,MOTORCYCLE, BUS transport mode with occupant role DRIVER. For rest of transport modes/occupant roles this filed is ignored and null is returned.
`scores` - `UserEngagementTransportAggregationsData_UserEngagementTransportScoresAggregations`	Scores for the aggregation. Only applicable for CAR, MOTORCYCLE, BUS transport mode with occupant role DRIVER. For rest of transport modes/occupant roles this filed is ignored and null is returned.
`distance` - `Float`	Value of chosen aggregation type for distance. Unit is meters.
`duration` - `Float`	Value of chosen aggregation type for duration. Unit is minutes.

Example

{
  "events": UserEngagementTransportAggregationsData_UserEngagementTransportEventsAggregations,
  "scores": UserEngagementTransportAggregationsData_UserEngagementTransportScoresAggregations,
  "distance": 987.65,
  "duration": 987.65
}

Types

UserEngagementTransportAggregationsData_UserEngagementTransportEventsAggregations

Fields

Field Name	Description
`slice` - `[EngagementTransportEvent]`	List containing aggregated transport events. Available events are: CALL_EVENTS_COUNT, CALL_EVENTS_DURATION, PHONE_HANDLING_EVENTS_COUNT, PHONE_HANDLING_EVENTS_DURATION, SCREEN_EVENTS_COUNT, SCREEN_EVENTS_DURATION depending on your integration with Sentiance.

Example

{"slice": [EngagementTransportEvent]}

Types

UserEngagementTransportAggregationsData_UserEngagementTransportScoresAggregations

Fields

Field Name	Description
`slice` - `[EngagementScore]`	List containing aggregated scores. Available scores are: OVERALL_SCORE, MFFS_SCORE, ATTENTION_SCORE, HARSH_MOVEMENT_SCORE, FOCUS_SCORE, CALL_WHILE_MOVING_SCORE, LEGAL_SCORE, SMOOTH_SCORE depending on your integration with Sentiance.

Example

{"slice": [EngagementScore]}

Types

UserEngagementTransportAggregationsDimensions

Fields

Field Name	Description
`occupant_role` - `String`	Occupant role for the aggregation. Note: only applicable for CAR or BUS transport mode. For rest of transport modes this filed is ignored and null is returned.
`time_frame` - `TimeFrame`	Time frame for the aggregation.
`transport_mode` - `String`	Transport mode for the aggregation.

Example

{
  "occupant_role": "xyz789",
  "time_frame": TimeFrame,
  "transport_mode": "abc123"
}

Types

UserEngagementTransportAggregationsMetadata

Fields

Field Name	Description
`slice_by` - `SliceByEnum`	How data was sliced. Can be missing if the request didn't contain a slice_by field.
`function` - `AggregationFunctionEnum`	Type of aggregation performed.

Example

{"slice_by": "DAY", "function": "AVG"}

Types

UserEngagementTransportAggregationsSlice

Fields

Field Name	Description
`slice` - `[UserEngagementTransportsAggregations]`	Slice of aggregated data for the user.

Example

{"slice": [UserEngagementTransportsAggregations]}

Types

UserEngagementTransportScores

Fields

Field Name	Description
`slice` - `[EngagementScore]`	List containing scores. Available scores are: OVERALL_SCORE, MFFS_SCORE, ATTENTION_SCORE, HARSH_MOVEMENT_SCORE, FOCUS_SCORE, CALL_WHILE_MOVING_SCORE, LEGAL_SCORE, SMOOTH_SCORE depending on your integration with Sentiance.

Example

{"slice": [EngagementScore]}

Types

UserEngagementTransportTrajectory

Fields

Field Name	Description
`end_location` - `UserEngagementTransportTrajectoryLocation`	End location of the transport.
`start_location` - `UserEngagementTransportTrajectoryLocation`	Start location of the transport.
`polyline` - `String`	The encoded path using Google's Encoded Polyline Algorithm format.
`distance` - `Float`	Total distance travelled in meters.

Example

{
  "end_location": UserEngagementTransportTrajectoryLocation,
  "start_location": UserEngagementTransportTrajectoryLocation,
  "polyline": "abc123",
  "distance": 123.45
}

Types

UserEngagementTransportTrajectoryLocation

Fields

Field Name	Description
`city` - `String`	City name.
`country` - `String`	Country name.
`district` - `String`	District name.
`latitude` - `Float`	Latitude of the location.
`longitude` - `Float`	Longitude of the location.
`region` - `String`	Region name.
`street` - `String`	Street name.

Example

{
  "city": "xyz789",
  "country": "abc123",
  "district": "abc123",
  "latitude": 123.45,
  "longitude": 123.45,
  "region": "abc123",
  "street": "xyz789"
}

Types

UserEngagementTransports

Fields

Field Name	Description
`slice` - `[UserEngagementTransport]`	List of transports.
`meta` - `UserEngagementTransportsMeta`	Metadata of the transport response.

Example

{
  "slice": [UserEngagementTransport],
  "meta": UserEngagementTransportsMeta
}

Types

UserEngagementTransportsAggregations

Fields

Field Name	Description
`data` - `UserEngagementTransportAggregationsData`	Data that was aggregated.
`dimensions` - `UserEngagementTransportAggregationsDimensions`	Dimensions for the aggregation. All data is grouped by these dimensions except when it's not sliced, than is grouped only by transport mode and occupant role. The reason for this grouping is that this is how the Sentiance data makes sense and should be interpreted.
`metadata` - `UserEngagementTransportAggregationsMetadata`	Metadata for the aggregation.

Example

{
  "data": UserEngagementTransportAggregationsData,
  "dimensions": UserEngagementTransportAggregationsDimensions,
  "metadata": UserEngagementTransportAggregationsMetadata
}

Types

UserEngagementTransportsMeta

Fields

Field Name	Description
`next_token` - `String`	Pagination token to be used in the next transports request.

Example

{"next_token": "xyz789"}

Types

UserEngagementTransportsRequest_InGracePeriodEnum

Values

Enum Value	Description
`ALL`
`FALSE`
`TRUE`

Example

"ALL"

Types

UserEngagementTransportsRequest_OccupantRoleEnum

Values

Enum Value	Description
`ANY`
`DRIVER`
`DRIVER_AND_PASSENGER`
`PASSENGER`
`UNKNOWN`

Example

"ANY"

Types

UserEngagementTransportsRequest_TransportModeEnum

Values

Enum Value	Description
`ANY_MODE`
`BIKING`
`BUS`
`CAR`
`FERRY`
`IDLE`
`INSUFFICIENT_DATA`
`MOTORCYCLE`
`RUNNING`
`TRAIN`
`TRAM`
`UNSUPPORTED_MODE`
`WALKING`

Example

"ANY_MODE"

Types

UserScores

Fields

Field Name	Description
`driving` - `UserScoresDriving`

Example

{"driving": UserScoresDriving}

Types

UserScoresDriving

Fields

Field Name	Description
`safety` - `UserScoresDrivingSafety`

Example

{"safety": UserScoresDrivingSafety}

Types

UserScoresDrivingSafety

Fields

Field Name	Description
`primary` - `PrimarySafetyScores`	Primary safety scores belonging to the user.
`secondary` - `SecondarySafetyScores`	Secondary safety scores belonging to the user.
`unified` - `UnifiedSafetyScores`	Unified safety scores belonging to the user.

Example

{
  "primary": PrimarySafetyScores,
  "secondary": SecondarySafetyScores,
  "unified": UnifiedSafetyScores
}

Types

WeatherData

Fields

Field Name	Description
`cloud_cover` - `Float`	Cloud cover as a fraction between 0-1.
`dew_point` - `Float`	Dew point in degrees celcius
`temperature` - `Float`	Instantaneous temperature at 2m above ground in degrees Celsius
`precipitation_intensity` - `Float`	Precipitation accumulated over the past hour in millimeter
`pressure` - `Float`	Pressure in millibars
`precipitation_probability` - `Float`	Probability of precipitation
`humidity` - `Float`	Relative humidity as a fraction between 0-1.
`summary` - `String`	Textual description of the weather
`apparent_temperature` - `Float`	The apparent temperature is a measure for the human thermal comfort. On the basis of the air temperature, the apparent temperature is computed considering effects of relative humidity, wind speed and solar radiation.
`icon` - `String`	URL of the icon representing the weather
`uv_index` - `Float`	UV Index
`visibility` - `Float`	Visibility in km
`wind_bearing` - `Float`	Wind direction in degrees due north
`wind_gust` - `Float`	Wind gust in m/s
`wind_speed` - `Float`	Wind speed in m/s
`ozone` - `Float`	deprecated; no longer available
`sunrise` - `String`	time of sunrise
`sunset` - `String`	time of sunset

Example

{
  "cloud_cover": 987.65,
  "dew_point": 987.65,
  "temperature": 987.65,
  "precipitation_intensity": 987.65,
  "pressure": 987.65,
  "precipitation_probability": 987.65,
  "humidity": 987.65,
  "summary": "xyz789",
  "apparent_temperature": 987.65,
  "icon": "xyz789",
  "uv_index": 987.65,
  "visibility": 123.45,
  "wind_bearing": 987.65,
  "wind_gust": 987.65,
  "wind_speed": 123.45,
  "ozone": 987.65,
  "sunrise": "abc123",
  "sunset": "abc123"
}

Types

WrongWayEvent

Fields

Field Name	Description
`duration` - `Float`	Duration of the wrong way event in seconds.
`path` - `[PathElement]`	Path (waypoints) of the wrong way event while it lasted.
`end_at` - `String`	The end time of the wrong way event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`category` - `String`	The main category of the wrong way event.
`start_at` - `String`	The start time of the wrong way event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).
`type` - `String`	The sub type of the wrong way event.

Example

{
  "duration": 123.45,
  "path": [PathElement],
  "end_at": "abc123",
  "category": "xyz789",
  "start_at": "abc123",
  "type": "xyz789"
}

Documentation by Anvil SpectaQL