Traffitech GraphQL API Reference
The following page is a documentation for Traffitech's open vehicle platform
Terms of Service
API Endpoints
# Production:
https://www.obiplus.net/data/api/v3/graphql
Headers
# Add token here
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
driver
Example
Query
query Driver($id: ID!) {
driver(id: $id) {
driver_id
org_short_id
first_name
last_name
email
org_id
client_id
worker_id
updated_at
phone
image_url
driver_codes {
code
type
expires
}
journey {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
journeys {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
daily_summaries {
id
timestamp
key
date
speed_avg_kmh
speed_avg_mph
speed_max_kmh
speed_max_mph
duration_s
duration_coasting_s
duration_coasting_percents
distance_coasting_m
distance_coasting_percents
duration_idle_s
duration_idle_percents
duration_driving_s
duration_driving_percents
consumption_electricity_wh
consumption_electricity_idle_wh
efficiency_avg_electricity_wkm
efficiency_avg_electricity_kw100km
efficiency_avg_electricity_mpkwh
efficiency_avg_electricity_mpge
consumption_fuel_ml
consumption_fuel_idle_ml
efficiency_avg_fuel_kml
efficiency_avg_fuel_mpg
efficiency_avg_fuel_l100km
efficiency_avg_fuel_l10km
distance_m
distance_km
distance_10km
distance_mile
behavior_events_100km
behavior_events_driving_hour
driver_id
behavior_score
vehicle_id
driver_login_percents
ignition_first_time
ignition_last_time
battery_first_voltage
battery_last_voltage
battery_min_voltage
battery_max_voltage
battery_avg_voltage
}
current_vehicle {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
...DashboardEntryFragment
}
timeseries {
...VehicleTimeSeriesFragment
}
j1939_dtcs {
...J1939DTCFragment
}
obd_dtcs {
...OBDDTCFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
routes {
...RouteFragment
}
daily_summaries {
...DailySummaryFragment
}
parameter_daily_summaries {
...VehicleParameterDailySummaryFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
geofence_vehicle_statuses {
...GeofenceStatusFragment
}
overspeed_by_road_events {
...OverspeedByRoadEventFragment
}
service_remaining_brake_lining_percents {
...PositionValueTimeseriesFloatFragment
}
interior_temperature_degrees_c {
...PositionValueTimeseriesFloatFragment
}
fuel_transactions {
...FuelTransactionEntryFragment
}
re_raw_can_recording {
...RawCanRecordingFragment
}
device {
...DeviceFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"driver": {
"driver_id": "4",
"org_short_id": "abc123",
"first_name": "xyz789",
"last_name": "xyz789",
"email": "abc123",
"org_id": "4",
"client_id": "4",
"worker_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"phone": "xyz789",
"image_url": "xyz789",
"driver_codes": [DriverCode],
"journey": Journey,
"journeys": [Journey],
"daily_summaries": [DailySummary],
"current_vehicle": Vehicle
}
}
}
organization
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
short_id - String!
|
Example
Query
query Organization($short_id: String!) {
organization(short_id: $short_id) {
id
short_id
name
type
customer_number
key_accounts
contacts
updated_at
parent_short_id
sync
bi_load_type
bi_full_load_from
vehicles {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
...DashboardEntryFragment
}
timeseries {
...VehicleTimeSeriesFragment
}
j1939_dtcs {
...J1939DTCFragment
}
obd_dtcs {
...OBDDTCFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
routes {
...RouteFragment
}
daily_summaries {
...DailySummaryFragment
}
parameter_daily_summaries {
...VehicleParameterDailySummaryFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
geofence_vehicle_statuses {
...GeofenceStatusFragment
}
overspeed_by_road_events {
...OverspeedByRoadEventFragment
}
service_remaining_brake_lining_percents {
...PositionValueTimeseriesFloatFragment
}
interior_temperature_degrees_c {
...PositionValueTimeseriesFloatFragment
}
fuel_transactions {
...FuelTransactionEntryFragment
}
re_raw_can_recording {
...RawCanRecordingFragment
}
device {
...DeviceFragment
}
}
drivers {
driver_id
org_short_id
first_name
last_name
email
org_id
client_id
worker_id
updated_at
phone
image_url
driver_codes {
...DriverCodeFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
daily_summaries {
...DailySummaryFragment
}
current_vehicle {
...VehicleFragment
}
}
}
}
Variables
{"short_id": "abc123"}
Response
{
"data": {
"organization": {
"id": "4",
"short_id": "xyz789",
"name": "abc123",
"type": "xyz789",
"customer_number": "xyz789",
"key_accounts": ["xyz789"],
"contacts": {},
"updated_at": "2007-12-03T10:15:30Z",
"parent_short_id": "xyz789",
"sync": {},
"bi_load_type": "abc123",
"bi_full_load_from": "2007-12-03T10:15:30Z",
"vehicles": [Vehicle],
"drivers": [Driver]
}
}
}
organizations
Response
Returns [Organization]
Arguments
| Name | Description |
|---|---|
short_id - [String]!
|
Example
Query
query Organizations($short_id: [String]!) {
organizations(short_id: $short_id) {
id
short_id
name
type
customer_number
key_accounts
contacts
updated_at
parent_short_id
sync
bi_load_type
bi_full_load_from
vehicles {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
...DashboardEntryFragment
}
timeseries {
...VehicleTimeSeriesFragment
}
j1939_dtcs {
...J1939DTCFragment
}
obd_dtcs {
...OBDDTCFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
routes {
...RouteFragment
}
daily_summaries {
...DailySummaryFragment
}
parameter_daily_summaries {
...VehicleParameterDailySummaryFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
geofence_vehicle_statuses {
...GeofenceStatusFragment
}
overspeed_by_road_events {
...OverspeedByRoadEventFragment
}
service_remaining_brake_lining_percents {
...PositionValueTimeseriesFloatFragment
}
interior_temperature_degrees_c {
...PositionValueTimeseriesFloatFragment
}
fuel_transactions {
...FuelTransactionEntryFragment
}
re_raw_can_recording {
...RawCanRecordingFragment
}
device {
...DeviceFragment
}
}
drivers {
driver_id
org_short_id
first_name
last_name
email
org_id
client_id
worker_id
updated_at
phone
image_url
driver_codes {
...DriverCodeFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
daily_summaries {
...DailySummaryFragment
}
current_vehicle {
...VehicleFragment
}
}
}
}
Variables
{"short_id": ["abc123"]}
Response
{
"data": {
"organizations": [
{
"id": "4",
"short_id": "xyz789",
"name": "xyz789",
"type": "abc123",
"customer_number": "abc123",
"key_accounts": ["xyz789"],
"contacts": {},
"updated_at": "2007-12-03T10:15:30Z",
"parent_short_id": "xyz789",
"sync": {},
"bi_load_type": "xyz789",
"bi_full_load_from": "2007-12-03T10:15:30Z",
"vehicles": [Vehicle],
"drivers": [Driver]
}
]
}
}
vehicle
Example
Query
query Vehicle($short_id: String!) {
vehicle(short_id: $short_id) {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
vehicle_id
table_name
value
timestamp
}
timeseries {
wiper_state {
...TimeseriesBooleanEntryFragment
}
ignition_state {
...TimeseriesBooleanEntryFragment
}
service_mil {
...TimeseriesBooleanEntryFragment
}
device_dmas_connect_state {
...TimeseriesBooleanEntryFragment
}
device_external_power_source_connect_state {
...TimeseriesBooleanEntryFragment
}
service_indicator {
...TimeseriesBooleanEntryFragment
}
service_garage_mode_state {
...TimeseriesBooleanEntryFragment
}
battery_voltage_volts {
...TimeseriesFloatEntryFragment
}
coolant_temperature_degrees_c {
...TimeseriesFloatEntryFragment
}
ambient_air_temperature_degrees_c {
...TimeseriesFloatEntryFragment
}
fuel_dashboard_percents {
...TimeseriesFloatEntryFragment
}
ev_charge_level_percents {
...TimeseriesFloatEntryFragment
}
ev_battery_hv_voltage_volts {
...TimeseriesFloatEntryFragment
}
service_distance_from_last_service_meters {
...TimeseriesFloatEntryFragment
}
fuel_dashboard_ml {
...TimeseriesIntEntryFragment
}
ev_charge_level_wh {
...TimeseriesIntEntryFragment
}
mileage_dashboard_meters {
...TimeseriesIntEntryFragment
}
mileage_gps_meters {
...TimeseriesIntEntryFragment
}
service_adblue_remaining_distance_meters {
...TimeseriesIntEntryFragment
}
service_mileage_to_next_inspection_meters {
...TimeseriesIntEntryFragment
}
service_distance_to_oil_change_meters {
...TimeseriesIntEntryFragment
}
raw_inertial_data {
...TimeseriesJsonEntryFragment
}
}
j1939_dtcs {
fmi
spn
source
active
activeRanges
info {
...DTCDescriptionFragment
}
}
obd_dtcs {
dtc
ecu
mode
active
activeRanges
info {
...DTCDescriptionFragment
}
}
journey {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
journeys {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
routes {
duration_total
section_count
address_start
address_end
timestamp
timestamp_end
duration
duration_idle
distance
fuel_consumption
fuel_consumption_idle
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
max_recorded_speed
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
journeys {
...JourneyFragment
}
}
daily_summaries {
id
timestamp
key
date
speed_avg_kmh
speed_avg_mph
speed_max_kmh
speed_max_mph
duration_s
duration_coasting_s
duration_coasting_percents
distance_coasting_m
distance_coasting_percents
duration_idle_s
duration_idle_percents
duration_driving_s
duration_driving_percents
consumption_electricity_wh
consumption_electricity_idle_wh
efficiency_avg_electricity_wkm
efficiency_avg_electricity_kw100km
efficiency_avg_electricity_mpkwh
efficiency_avg_electricity_mpge
consumption_fuel_ml
consumption_fuel_idle_ml
efficiency_avg_fuel_kml
efficiency_avg_fuel_mpg
efficiency_avg_fuel_l100km
efficiency_avg_fuel_l10km
distance_m
distance_km
distance_10km
distance_mile
behavior_events_100km
behavior_events_driving_hour
driver_id
behavior_score
vehicle_id
driver_login_percents
ignition_first_time
ignition_last_time
battery_first_voltage
battery_last_voltage
battery_min_voltage
battery_max_voltage
battery_avg_voltage
}
parameter_daily_summaries {
id
vehicle_id
timestamp
date
table_name
value_first
value_last
value_max
value_min
value_count
value_avg
}
behaviour_events {
id
vehicle_id
timestamp
location {
...BasicLocationFragment
}
event
duration_ms
dir_begin
dir_end
dir_peak
speed_begin
speed_end
speed_peak
acc_x_begin
acc_x_end
acc_x_peak
acc_y_begin
acc_y_end
acc_y_peak
acc_z_begin
acc_z_end
acc_z_peak
angle
severity
date
driver_journey_id
address
}
parameter_state_ranges {
id
vehicle_id
type
timestamp_on
timestamp_off
duration
location_on {
...BasicLocationFragment
}
location_off {
...BasicLocationFragment
}
address_on
address_off
speed_on
speed_off
driver_journey_id
date
trace {
...LocationFragment
}
}
video_recordings {
id
vehicle_id
cam_id
duration
media {
...VideoMediaFragment
}
timestamp
request_type
trigger
event_timestamp
size
}
geofence_vehicle_statuses {
id
geofence_id
vehicle_id
location {
...BasicLocationFragment
}
status
is_latest
timestamp
}
overspeed_by_road_events {
id
vehicle_id
timestamp_on
timestamp_off
driver_journey_id
distance
duration
location_on {
...BasicLocationFragment
}
location_off {
...BasicLocationFragment
}
percent_over_avg
percent_over_max
speed_avg
speed_max
speed_over_avg
speed_over_max
speed_limit
trace {
...LocationFragment
}
}
service_remaining_brake_lining_percents {
position
timeseries {
...TimeseriesFloatEntryFragment
}
}
interior_temperature_degrees_c {
position
timeseries {
...TimeseriesFloatEntryFragment
}
}
fuel_transactions {
id
vehicle_id
timestamp
timezone
date
vendor
station_name
station_id
station_location
product_type
product_name
product_unit
product_quantity
product_price_per_unit
distance_since_last_fueling
price
price_currency
transaction_id
payment_token_pan
payment_token_expire_date
customer_reference
customer_name
raw_transaction_data
vehicle_distance_to_station
vehicle_ignition_off_duration_from_transaction
vehicle_fuel_reading_transaction_delta
suspicious_flag
}
re_raw_can_recording {
id
vehicle_id
timestamp
can_address
can_address_hex
can_data
can_data_hex
}
device {
id
device_id
org_short_id
type
updated_at
org_id
state {
...DeviceStateFragment
}
}
}
}
Variables
{"short_id": "abc123"}
Response
{
"data": {
"vehicle": {
"id": "4",
"short_id": "abc123",
"org_short_id": "xyz789",
"registration_id": "abc123",
"registration_country": "abc123",
"vin": "xyz789",
"make": "xyz789",
"model": "abc123",
"production_date": "2007-12-03T10:15:30Z",
"tags": {},
"device_id": "abc123",
"cam_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"org_id": "4",
"client_id": 4,
"engine_type": "abc123",
"co2_emisisons_per_km": 123,
"fueltank_capacity_ml": 123,
"battery_capacity_wh": 123,
"type": "xyz789",
"dashboard": [DashboardEntry],
"timeseries": VehicleTimeSeries,
"j1939_dtcs": [J1939DTC],
"obd_dtcs": [OBDDTC],
"journey": Journey,
"journeys": [Journey],
"routes": [Route],
"daily_summaries": [DailySummary],
"parameter_daily_summaries": [
VehicleParameterDailySummary
],
"behaviour_events": [BehaviourEvent],
"parameter_state_ranges": [ParameterStateRange],
"video_recordings": [VideoRecording],
"geofence_vehicle_statuses": [GeofenceStatus],
"overspeed_by_road_events": [OverspeedByRoadEvent],
"service_remaining_brake_lining_percents": [
PositionValueTimeseriesFloat
],
"interior_temperature_degrees_c": [
PositionValueTimeseriesFloat
],
"fuel_transactions": [FuelTransactionEntry],
"re_raw_can_recording": [RawCanRecording],
"device": Device
}
}
}
vehicles
Response
Returns [Vehicle]
Example
Query
query Vehicles(
$short_id: [String],
$device_prefix: String,
$q: String
) {
vehicles(
short_id: $short_id,
device_prefix: $device_prefix,
q: $q
) {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
vehicle_id
table_name
value
timestamp
}
timeseries {
wiper_state {
...TimeseriesBooleanEntryFragment
}
ignition_state {
...TimeseriesBooleanEntryFragment
}
service_mil {
...TimeseriesBooleanEntryFragment
}
device_dmas_connect_state {
...TimeseriesBooleanEntryFragment
}
device_external_power_source_connect_state {
...TimeseriesBooleanEntryFragment
}
service_indicator {
...TimeseriesBooleanEntryFragment
}
service_garage_mode_state {
...TimeseriesBooleanEntryFragment
}
battery_voltage_volts {
...TimeseriesFloatEntryFragment
}
coolant_temperature_degrees_c {
...TimeseriesFloatEntryFragment
}
ambient_air_temperature_degrees_c {
...TimeseriesFloatEntryFragment
}
fuel_dashboard_percents {
...TimeseriesFloatEntryFragment
}
ev_charge_level_percents {
...TimeseriesFloatEntryFragment
}
ev_battery_hv_voltage_volts {
...TimeseriesFloatEntryFragment
}
service_distance_from_last_service_meters {
...TimeseriesFloatEntryFragment
}
fuel_dashboard_ml {
...TimeseriesIntEntryFragment
}
ev_charge_level_wh {
...TimeseriesIntEntryFragment
}
mileage_dashboard_meters {
...TimeseriesIntEntryFragment
}
mileage_gps_meters {
...TimeseriesIntEntryFragment
}
service_adblue_remaining_distance_meters {
...TimeseriesIntEntryFragment
}
service_mileage_to_next_inspection_meters {
...TimeseriesIntEntryFragment
}
service_distance_to_oil_change_meters {
...TimeseriesIntEntryFragment
}
raw_inertial_data {
...TimeseriesJsonEntryFragment
}
}
j1939_dtcs {
fmi
spn
source
active
activeRanges
info {
...DTCDescriptionFragment
}
}
obd_dtcs {
dtc
ecu
mode
active
activeRanges
info {
...DTCDescriptionFragment
}
}
journey {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
journeys {
id
vehicle_id
driver {
...DriverInfoFragment
}
driver_id
driver_code
timestamp
timestamp_end
address_start
address_end
distance
duration
duration_idle
fuel_consumption
flag
note
fuel_consumption_idle
journey_id
max_recorded_speed
duration_from_prev_journey
date
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
total_mileage
duration_engine_running
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
locations {
...LocationFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
behaviour_events_by_type_count
parameter_state_ranges_by_type_count
video_recordings_by_request_type_count
vehicle {
...VehicleInfoFragment
}
}
routes {
duration_total
section_count
address_start
address_end
timestamp
timestamp_end
duration
duration_idle
distance
fuel_consumption
fuel_consumption_idle
electricity_consumption
electricity_consumption_idle
distance_coasting
duration_coasting
max_recorded_speed
location_start {
...BasicLocationFragment
}
location_end {
...BasicLocationFragment
}
journeys {
...JourneyFragment
}
}
daily_summaries {
id
timestamp
key
date
speed_avg_kmh
speed_avg_mph
speed_max_kmh
speed_max_mph
duration_s
duration_coasting_s
duration_coasting_percents
distance_coasting_m
distance_coasting_percents
duration_idle_s
duration_idle_percents
duration_driving_s
duration_driving_percents
consumption_electricity_wh
consumption_electricity_idle_wh
efficiency_avg_electricity_wkm
efficiency_avg_electricity_kw100km
efficiency_avg_electricity_mpkwh
efficiency_avg_electricity_mpge
consumption_fuel_ml
consumption_fuel_idle_ml
efficiency_avg_fuel_kml
efficiency_avg_fuel_mpg
efficiency_avg_fuel_l100km
efficiency_avg_fuel_l10km
distance_m
distance_km
distance_10km
distance_mile
behavior_events_100km
behavior_events_driving_hour
driver_id
behavior_score
vehicle_id
driver_login_percents
ignition_first_time
ignition_last_time
battery_first_voltage
battery_last_voltage
battery_min_voltage
battery_max_voltage
battery_avg_voltage
}
parameter_daily_summaries {
id
vehicle_id
timestamp
date
table_name
value_first
value_last
value_max
value_min
value_count
value_avg
}
behaviour_events {
id
vehicle_id
timestamp
location {
...BasicLocationFragment
}
event
duration_ms
dir_begin
dir_end
dir_peak
speed_begin
speed_end
speed_peak
acc_x_begin
acc_x_end
acc_x_peak
acc_y_begin
acc_y_end
acc_y_peak
acc_z_begin
acc_z_end
acc_z_peak
angle
severity
date
driver_journey_id
address
}
parameter_state_ranges {
id
vehicle_id
type
timestamp_on
timestamp_off
duration
location_on {
...BasicLocationFragment
}
location_off {
...BasicLocationFragment
}
address_on
address_off
speed_on
speed_off
driver_journey_id
date
trace {
...LocationFragment
}
}
video_recordings {
id
vehicle_id
cam_id
duration
media {
...VideoMediaFragment
}
timestamp
request_type
trigger
event_timestamp
size
}
geofence_vehicle_statuses {
id
geofence_id
vehicle_id
location {
...BasicLocationFragment
}
status
is_latest
timestamp
}
overspeed_by_road_events {
id
vehicle_id
timestamp_on
timestamp_off
driver_journey_id
distance
duration
location_on {
...BasicLocationFragment
}
location_off {
...BasicLocationFragment
}
percent_over_avg
percent_over_max
speed_avg
speed_max
speed_over_avg
speed_over_max
speed_limit
trace {
...LocationFragment
}
}
service_remaining_brake_lining_percents {
position
timeseries {
...TimeseriesFloatEntryFragment
}
}
interior_temperature_degrees_c {
position
timeseries {
...TimeseriesFloatEntryFragment
}
}
fuel_transactions {
id
vehicle_id
timestamp
timezone
date
vendor
station_name
station_id
station_location
product_type
product_name
product_unit
product_quantity
product_price_per_unit
distance_since_last_fueling
price
price_currency
transaction_id
payment_token_pan
payment_token_expire_date
customer_reference
customer_name
raw_transaction_data
vehicle_distance_to_station
vehicle_ignition_off_duration_from_transaction
vehicle_fuel_reading_transaction_delta
suspicious_flag
}
re_raw_can_recording {
id
vehicle_id
timestamp
can_address
can_address_hex
can_data
can_data_hex
}
device {
id
device_id
org_short_id
type
updated_at
org_id
state {
...DeviceStateFragment
}
}
}
}
Variables
{
"short_id": ["xyz789"],
"device_prefix": "abc123",
"q": "abc123"
}
Response
{
"data": {
"vehicles": [
{
"id": "4",
"short_id": "abc123",
"org_short_id": "abc123",
"registration_id": "xyz789",
"registration_country": "abc123",
"vin": "xyz789",
"make": "abc123",
"model": "abc123",
"production_date": "2007-12-03T10:15:30Z",
"tags": {},
"device_id": "abc123",
"cam_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"org_id": 4,
"client_id": 4,
"engine_type": "abc123",
"co2_emisisons_per_km": 987,
"fueltank_capacity_ml": 987,
"battery_capacity_wh": 123,
"type": "xyz789",
"dashboard": [DashboardEntry],
"timeseries": VehicleTimeSeries,
"j1939_dtcs": [J1939DTC],
"obd_dtcs": [OBDDTC],
"journey": Journey,
"journeys": [Journey],
"routes": [Route],
"daily_summaries": [DailySummary],
"parameter_daily_summaries": [
VehicleParameterDailySummary
],
"behaviour_events": [BehaviourEvent],
"parameter_state_ranges": [ParameterStateRange],
"video_recordings": [VideoRecording],
"geofence_vehicle_statuses": [GeofenceStatus],
"overspeed_by_road_events": [
OverspeedByRoadEvent
],
"service_remaining_brake_lining_percents": [
PositionValueTimeseriesFloat
],
"interior_temperature_degrees_c": [
PositionValueTimeseriesFloat
],
"fuel_transactions": [FuelTransactionEntry],
"re_raw_can_recording": [RawCanRecording],
"device": Device
}
]
}
}
vehicles_paged
Response
Returns a PagedVehicles
Example
Query
query Vehicles_paged(
$short_id: [String],
$device_prefix: String,
$page: Int,
$limit: Int,
$q: String
) {
vehicles_paged(
short_id: $short_id,
device_prefix: $device_prefix,
page: $page,
limit: $limit,
q: $q
) {
data {
id
short_id
org_short_id
registration_id
registration_country
vin
make
model
production_date
tags
device_id
cam_id
updated_at
org_id
client_id
engine_type
co2_emisisons_per_km
fueltank_capacity_ml
battery_capacity_wh
type
dashboard {
...DashboardEntryFragment
}
timeseries {
...VehicleTimeSeriesFragment
}
j1939_dtcs {
...J1939DTCFragment
}
obd_dtcs {
...OBDDTCFragment
}
journey {
...JourneyFragment
}
journeys {
...JourneyFragment
}
routes {
...RouteFragment
}
daily_summaries {
...DailySummaryFragment
}
parameter_daily_summaries {
...VehicleParameterDailySummaryFragment
}
behaviour_events {
...BehaviourEventFragment
}
parameter_state_ranges {
...ParameterStateRangeFragment
}
video_recordings {
...VideoRecordingFragment
}
geofence_vehicle_statuses {
...GeofenceStatusFragment
}
overspeed_by_road_events {
...OverspeedByRoadEventFragment
}
service_remaining_brake_lining_percents {
...PositionValueTimeseriesFloatFragment
}
interior_temperature_degrees_c {
...PositionValueTimeseriesFloatFragment
}
fuel_transactions {
...FuelTransactionEntryFragment
}
re_raw_can_recording {
...RawCanRecordingFragment
}
device {
...DeviceFragment
}
}
page
total_count
}
}
Variables
{
"short_id": ["abc123"],
"device_prefix": "xyz789",
"page": 987,
"limit": 987,
"q": "abc123"
}
Response
{
"data": {
"vehicles_paged": {
"data": [Vehicle],
"page": 987,
"total_count": 123
}
}
}
Mutations
deleteDashboardData
Response
Returns a Boolean!
Example
Query
mutation DeleteDashboardData(
$vehicle_short_id: String!,
$timestamp_before: DateTime
) {
deleteDashboardData(
vehicle_short_id: $vehicle_short_id,
timestamp_before: $timestamp_before
)
}
Variables
{
"vehicle_short_id": "abc123",
"timestamp_before": "2007-12-03T10:15:30Z"
}
Response
{"data": {"deleteDashboardData": false}}
updateJourneyFlag
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
vehicle_short_id - String!
|
|
journey_id - Int!
|
|
flag - JourneyFlagType!
|
Example
Query
mutation UpdateJourneyFlag(
$vehicle_short_id: String!,
$journey_id: Int!,
$flag: JourneyFlagType!
) {
updateJourneyFlag(
vehicle_short_id: $vehicle_short_id,
journey_id: $journey_id,
flag: $flag
)
}
Variables
{
"vehicle_short_id": "abc123",
"journey_id": 123,
"flag": "private"
}
Response
{"data": {"updateJourneyFlag": true}}
Types
BasicLocation
BehaviourEvent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vehicle_id - ID!
|
|
timestamp - DateTime
|
|
location - BasicLocation
|
|
event - String
|
|
duration_ms - Int
|
|
dir_begin - Int
|
|
dir_end - Int
|
|
dir_peak - Int
|
|
speed_begin - Int
|
|
speed_end - Int
|
|
speed_peak - Int
|
|
acc_x_begin - Int
|
|
acc_x_end - Int
|
|
acc_x_peak - Int
|
|
acc_y_begin - Int
|
|
acc_y_end - Int
|
|
acc_y_peak - Int
|
|
acc_z_begin - Int
|
|
acc_z_end - Int
|
|
acc_z_peak - Int
|
|
angle - Int
|
|
severity - Int
|
|
date - Date
|
|
driver_journey_id - ID
|
|
address - String
|
Example
{
"id": 4,
"vehicle_id": "4",
"timestamp": "2007-12-03T10:15:30Z",
"location": BasicLocation,
"event": "xyz789",
"duration_ms": 987,
"dir_begin": 123,
"dir_end": 987,
"dir_peak": 123,
"speed_begin": 987,
"speed_end": 987,
"speed_peak": 123,
"acc_x_begin": 987,
"acc_x_end": 123,
"acc_x_peak": 123,
"acc_y_begin": 987,
"acc_y_end": 123,
"acc_y_peak": 987,
"acc_z_begin": 987,
"acc_z_end": 987,
"acc_z_peak": 123,
"angle": 123,
"severity": 987,
"date": "2007-12-03",
"driver_journey_id": "4",
"address": "xyz789"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CanExecutionSettings
CanParameter
Fields
| Field Name | Description |
|---|---|
communicationType - Int
|
|
request - [CanParameterRequest]
|
|
response - CanParameterResponse
|
|
maxPollingMsWhileMoving - Int
|
|
maxPollingMsWhileIgnitionOn - Int
|
|
maxPollingMsWhileIgnitionOff - Int
|
|
globalNumber - String
|
|
connectionPoint - Int
|
|
baudRate - Int
|
|
protocol - Int
|
|
hash - String
|
Example
{
"communicationType": 987,
"request": [CanParameterRequest],
"response": CanParameterResponse,
"maxPollingMsWhileMoving": 987,
"maxPollingMsWhileIgnitionOn": 987,
"maxPollingMsWhileIgnitionOff": 987,
"globalNumber": "xyz789",
"connectionPoint": 987,
"baudRate": 987,
"protocol": 987,
"hash": "xyz789"
}
CanParameterConf
Fields
| Field Name | Description |
|---|---|
canParameter - CanParameter
|
|
executionSettings - CanExecutionSettings
|
Example
{
"canParameter": CanParameter,
"executionSettings": CanExecutionSettings
}
CanParameterRequest
CanParameterResponse
Example
{
"id": "xyz789",
"waitTimeoutMs": 987,
"offset": 987,
"dataLength": 987,
"mask": "xyz789",
"precision": 987.65,
"addition": 123,
"min": 123,
"max": 987,
"format": 123
}
CanSettings
Example
{
"canRulesEnabled": false,
"baudRate": 123,
"obd2Enabled": true,
"scannerDetectionEnabled": true,
"proprietaryDtcCheckEnabled": true
}
DTCDescription
DailySummary
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
timestamp - DateTime
|
|
key - String
|
|
date - Date
|
|
speed_avg_kmh - Float
|
|
speed_avg_mph - Float
|
|
speed_max_kmh - Int
|
|
speed_max_mph - Float
|
|
duration_s - Int
|
|
duration_coasting_s - Int
|
|
duration_coasting_percents - Float
|
|
distance_coasting_m - Int
|
|
distance_coasting_percents - Float
|
|
duration_idle_s - Int
|
|
duration_idle_percents - Int
|
|
duration_driving_s - Int
|
|
duration_driving_percents - Int
|
|
consumption_electricity_wh - Int
|
|
consumption_electricity_idle_wh - Int
|
|
efficiency_avg_electricity_wkm - Int
|
|
efficiency_avg_electricity_kw100km - Float
|
|
efficiency_avg_electricity_mpkwh - Float
|
|
efficiency_avg_electricity_mpge - Float
|
|
consumption_fuel_ml - Int
|
|
consumption_fuel_idle_ml - Int
|
|
efficiency_avg_fuel_kml - Float
|
|
efficiency_avg_fuel_mpg - Float
|
|
efficiency_avg_fuel_l100km - Float
|
|
efficiency_avg_fuel_l10km - Float
|
|
distance_m - Int
|
|
distance_km - Float
|
|
distance_10km - Float
|
|
distance_mile - Float
|
|
behavior_events_100km - Float
|
|
behavior_events_driving_hour - Float
|
|
driver_id - ID
|
|
behavior_score - Float
|
|
vehicle_id - ID
|
|
driver_login_percents - Float
|
|
ignition_first_time - String
|
|
ignition_last_time - String
|
|
battery_first_voltage - Float
|
|
battery_last_voltage - Float
|
|
battery_min_voltage - Float
|
|
battery_max_voltage - Float
|
|
battery_avg_voltage - Float
|
Example
{
"id": "4",
"timestamp": "2007-12-03T10:15:30Z",
"key": "xyz789",
"date": "2007-12-03",
"speed_avg_kmh": 987.65,
"speed_avg_mph": 987.65,
"speed_max_kmh": 987,
"speed_max_mph": 987.65,
"duration_s": 123,
"duration_coasting_s": 987,
"duration_coasting_percents": 987.65,
"distance_coasting_m": 987,
"distance_coasting_percents": 987.65,
"duration_idle_s": 123,
"duration_idle_percents": 987,
"duration_driving_s": 123,
"duration_driving_percents": 123,
"consumption_electricity_wh": 987,
"consumption_electricity_idle_wh": 123,
"efficiency_avg_electricity_wkm": 987,
"efficiency_avg_electricity_kw100km": 987.65,
"efficiency_avg_electricity_mpkwh": 123.45,
"efficiency_avg_electricity_mpge": 987.65,
"consumption_fuel_ml": 987,
"consumption_fuel_idle_ml": 123,
"efficiency_avg_fuel_kml": 987.65,
"efficiency_avg_fuel_mpg": 123.45,
"efficiency_avg_fuel_l100km": 987.65,
"efficiency_avg_fuel_l10km": 987.65,
"distance_m": 123,
"distance_km": 987.65,
"distance_10km": 123.45,
"distance_mile": 987.65,
"behavior_events_100km": 987.65,
"behavior_events_driving_hour": 987.65,
"driver_id": 4,
"behavior_score": 123.45,
"vehicle_id": 4,
"driver_login_percents": 987.65,
"ignition_first_time": "xyz789",
"ignition_last_time": "abc123",
"battery_first_voltage": 987.65,
"battery_last_voltage": 987.65,
"battery_min_voltage": 987.65,
"battery_max_voltage": 123.45,
"battery_avg_voltage": 987.65
}
DashboardEntry
Date
Description
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
Device
Example
{
"id": "4",
"device_id": "abc123",
"org_short_id": "abc123",
"type": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"org_id": "4",
"state": DeviceState
}
DeviceState
Fields
| Field Name | Description |
|---|---|
deviceId - String
|
|
targetMCUSoftwareVersion - String
|
|
currentMCUSoftwareVersion - String
|
|
currentTraffilogCanSettings - CanSettings
|
|
targetTraffilogCanSettings - CanSettings
|
|
currentGpsTimeFrequency - Int
|
|
targetGpsTimeFrequency - Int
|
|
currentGpsAngleFrequency - Int
|
|
targetGpsAngleFrequency - Int
|
|
currentGpsDistanceFrequency - Int
|
|
targetGpsDistanceFrequency - Int
|
|
currentThresholdHarshAcceleration - Int
|
|
targetThresholdHarshAcceleration - Int
|
|
currentThresholdHarshDeceleration - Int
|
|
targetThresholdHarshDeceleration - Int
|
|
currentThresholdSharpTurn - Int
|
|
targetThresholdSharpTurn - Int
|
|
vin - String
|
|
currentCanParameters - [CanParameterConf]
|
|
targetCanParameters - [CanParameterConf]
|
Example
{
"deviceId": "xyz789",
"targetMCUSoftwareVersion": "xyz789",
"currentMCUSoftwareVersion": "xyz789",
"currentTraffilogCanSettings": CanSettings,
"targetTraffilogCanSettings": CanSettings,
"currentGpsTimeFrequency": 123,
"targetGpsTimeFrequency": 123,
"currentGpsAngleFrequency": 987,
"targetGpsAngleFrequency": 123,
"currentGpsDistanceFrequency": 987,
"targetGpsDistanceFrequency": 987,
"currentThresholdHarshAcceleration": 123,
"targetThresholdHarshAcceleration": 123,
"currentThresholdHarshDeceleration": 123,
"targetThresholdHarshDeceleration": 123,
"currentThresholdSharpTurn": 987,
"targetThresholdSharpTurn": 123,
"vin": "abc123",
"currentCanParameters": [CanParameterConf],
"targetCanParameters": [CanParameterConf]
}
Driver
Fields
| Field Name | Description |
|---|---|
driver_id - ID!
|
|
org_short_id - String
|
|
first_name - String
|
|
last_name - String
|
|
email - String
|
|
org_id - ID
|
|
client_id - ID
|
|
worker_id - String
|
|
updated_at - DateTime
|
|
phone - String
|
|
image_url - String
|
|
driver_codes - [DriverCode]
|
|
journey - Journey
|
|
Arguments
|
|
journeys - [Journey]
|
|
daily_summaries - [DailySummary]
|
|
current_vehicle - Vehicle
|
|
Example
{
"driver_id": "4",
"org_short_id": "xyz789",
"first_name": "xyz789",
"last_name": "xyz789",
"email": "abc123",
"org_id": "4",
"client_id": 4,
"worker_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"phone": "xyz789",
"image_url": "xyz789",
"driver_codes": [DriverCode],
"journey": Journey,
"journeys": [Journey],
"daily_summaries": [DailySummary],
"current_vehicle": Vehicle
}
DriverCode
DriverInfo
Example
{
"driver_id": "4",
"org_short_id": "abc123",
"first_name": "abc123",
"last_name": "abc123",
"email": "abc123",
"org_id": 4,
"client_id": 4,
"worker_id": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"phone": "abc123",
"image_url": "abc123",
"driver_codes": [DriverCode]
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FuelTransactionEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vehicle_id - ID!
|
|
timestamp - DateTime
|
|
timezone - String
|
|
date - Date
|
|
vendor - String
|
|
station_name - String
|
|
station_id - String
|
|
station_location - JSON
|
|
product_type - String
|
|
product_name - String
|
|
product_unit - String
|
|
product_quantity - Float
|
|
product_price_per_unit - Float
|
|
distance_since_last_fueling - Int
|
|
price - Float
|
|
price_currency - String
|
|
transaction_id - String
|
|
payment_token_pan - String
|
|
payment_token_expire_date - String
|
|
customer_reference - String
|
|
customer_name - String
|
|
raw_transaction_data - JSON
|
|
vehicle_distance_to_station - Int
|
|
vehicle_ignition_off_duration_from_transaction - Int
|
|
vehicle_fuel_reading_transaction_delta - Int
|
|
suspicious_flag - Boolean
|
Example
{
"id": 4,
"vehicle_id": "4",
"timestamp": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"date": "2007-12-03",
"vendor": "xyz789",
"station_name": "xyz789",
"station_id": "xyz789",
"station_location": {},
"product_type": "abc123",
"product_name": "abc123",
"product_unit": "xyz789",
"product_quantity": 123.45,
"product_price_per_unit": 987.65,
"distance_since_last_fueling": 987,
"price": 987.65,
"price_currency": "xyz789",
"transaction_id": "xyz789",
"payment_token_pan": "abc123",
"payment_token_expire_date": "abc123",
"customer_reference": "abc123",
"customer_name": "abc123",
"raw_transaction_data": {},
"vehicle_distance_to_station": 987,
"vehicle_ignition_off_duration_from_transaction": 123,
"vehicle_fuel_reading_transaction_delta": 987,
"suspicious_flag": true
}
GeofenceStatus
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
geofence_id - Int!
|
|
vehicle_id - ID!
|
|
location - BasicLocation
|
|
status - GeofenceStatusType
|
|
is_latest - Boolean
|
|
timestamp - DateTime
|
Example
{
"id": 4,
"geofence_id": 987,
"vehicle_id": 4,
"location": BasicLocation,
"status": "in",
"is_latest": true,
"timestamp": "2007-12-03T10:15:30Z"
}
GeofenceStatusType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"in"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
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
987
J1939DTC
Fields
| Field Name | Description |
|---|---|
fmi - Int
|
|
spn - Int
|
|
source - Int
|
|
active - Boolean
|
|
activeRanges - [DateTime]
|
|
info - DTCDescription
|
Example
{
"fmi": 987,
"spn": 987,
"source": 123,
"active": true,
"activeRanges": ["2007-12-03T10:15:30Z"],
"info": DTCDescription
}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
Journey
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vehicle_id - ID!
|
|
driver - DriverInfo
|
|
driver_id - ID
|
|
driver_code - String
|
|
timestamp - DateTime
|
|
timestamp_end - DateTime
|
|
address_start - String
|
|
address_end - String
|
|
distance - Int
|
|
duration - Int
|
|
duration_idle - Int
|
|
fuel_consumption - Int
|
|
flag - String
|
|
note - String
|
|
fuel_consumption_idle - Int
|
|
journey_id - ID!
|
|
max_recorded_speed - Int
|
|
duration_from_prev_journey - Int
|
|
date - Date
|
|
electricity_consumption - Int
|
|
electricity_consumption_idle - Int
|
|
distance_coasting - Int
|
|
duration_coasting - Int
|
|
total_mileage - Int
|
|
duration_engine_running - Int
|
|
location_start - BasicLocation
|
|
location_end - BasicLocation
|
|
locations - [Location]
|
|
behaviour_events - [BehaviourEvent]
|
|
parameter_state_ranges - [ParameterStateRange]
|
|
video_recordings - [VideoRecording]
|
|
behaviour_events_by_type_count - JSON
|
|
parameter_state_ranges_by_type_count - JSON
|
|
video_recordings_by_request_type_count - JSON
|
|
vehicle - VehicleInfo
|
Example
{
"id": "4",
"vehicle_id": "4",
"driver": DriverInfo,
"driver_id": "4",
"driver_code": "xyz789",
"timestamp": "2007-12-03T10:15:30Z",
"timestamp_end": "2007-12-03T10:15:30Z",
"address_start": "xyz789",
"address_end": "xyz789",
"distance": 123,
"duration": 987,
"duration_idle": 987,
"fuel_consumption": 123,
"flag": "xyz789",
"note": "abc123",
"fuel_consumption_idle": 123,
"journey_id": 4,
"max_recorded_speed": 123,
"duration_from_prev_journey": 987,
"date": "2007-12-03",
"electricity_consumption": 987,
"electricity_consumption_idle": 987,
"distance_coasting": 987,
"duration_coasting": 123,
"total_mileage": 123,
"duration_engine_running": 123,
"location_start": BasicLocation,
"location_end": BasicLocation,
"locations": [Location],
"behaviour_events": [BehaviourEvent],
"parameter_state_ranges": [ParameterStateRange],
"video_recordings": [VideoRecording],
"behaviour_events_by_type_count": {},
"parameter_state_ranges_by_type_count": {},
"video_recordings_by_request_type_count": {},
"vehicle": VehicleInfo
}
JourneyFlagType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"private"
Latitude
Description
A field whose value is a valid decimal degrees latitude number (53.471): https://en.wikipedia.org/wiki/Latitude
Example
41.902782
Location
Example
{
"id": "4",
"vehicle_id": "4",
"speed": 987,
"speed_limit": 987,
"direction": 123,
"timestamp": "2007-12-03T10:15:30Z",
"lat": 41.902782,
"lng": 12.496366
}
Longitude
Description
A field whose value is a valid decimal degrees longitude number (53.471): https://en.wikipedia.org/wiki/Longitude
Example
12.496366
OBDDTC
Fields
| Field Name | Description |
|---|---|
dtc - String
|
|
ecu - String
|
|
mode - Int
|
|
active - Boolean
|
|
activeRanges - [DateTime]
|
|
info - DTCDescription
|
Example
{
"dtc": "abc123",
"ecu": "abc123",
"mode": 123,
"active": false,
"activeRanges": ["2007-12-03T10:15:30Z"],
"info": DTCDescription
}
Organization
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
short_id - String
|
|
name - String
|
|
type - String
|
|
customer_number - String
|
|
key_accounts - [String]
|
|
contacts - JSON
|
|
updated_at - DateTime
|
|
parent_short_id - String
|
|
sync - JSON
|
|
bi_load_type - String
|
|
bi_full_load_from - DateTime
|
|
vehicles - [Vehicle]
|
|
Arguments
|
|
drivers - [Driver]
|
|
Example
{
"id": "4",
"short_id": "xyz789",
"name": "xyz789",
"type": "xyz789",
"customer_number": "xyz789",
"key_accounts": ["xyz789"],
"contacts": {},
"updated_at": "2007-12-03T10:15:30Z",
"parent_short_id": "abc123",
"sync": {},
"bi_load_type": "xyz789",
"bi_full_load_from": "2007-12-03T10:15:30Z",
"vehicles": [Vehicle],
"drivers": [Driver]
}
OverspeedByRoadEvent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vehicle_id - ID!
|
|
timestamp_on - DateTime
|
|
timestamp_off - DateTime
|
|
driver_journey_id - ID
|
|
distance - Int
|
|
duration - Int
|
|
location_on - BasicLocation
|
|
location_off - BasicLocation
|
|
percent_over_avg - Int
|
|
percent_over_max - Int
|
|
speed_avg - Int
|
|
speed_max - Int
|
|
speed_over_avg - Int
|
|
speed_over_max - Int
|
|
speed_limit - Int
|
|
trace - [Location]
|
Example
{
"id": "4",
"vehicle_id": 4,
"timestamp_on": "2007-12-03T10:15:30Z",
"timestamp_off": "2007-12-03T10:15:30Z",
"driver_journey_id": 4,
"distance": 987,
"duration": 987,
"location_on": BasicLocation,
"location_off": BasicLocation,
"percent_over_avg": 123,
"percent_over_max": 123,
"speed_avg": 123,
"speed_max": 123,
"speed_over_avg": 123,
"speed_over_max": 987,
"speed_limit": 987,
"trace": [Location]
}
PagedVehicles
ParamStateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"pto"
ParameterStateRange
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vehicle_id - ID!
|
|
type - ParamStateType
|
|
timestamp_on - DateTime
|
|
timestamp_off - DateTime
|
|
duration - Int
|
|
location_on - BasicLocation
|
|
location_off - BasicLocation
|
|
address_on - String
|
|
address_off - String
|
|
speed_on - Int
|
|
speed_off - Int
|
|
driver_journey_id - ID
|
|
date - Date
|
|
trace - [Location]
|
Example
{
"id": 4,
"vehicle_id": 4,
"type": "pto",
"timestamp_on": "2007-12-03T10:15:30Z",
"timestamp_off": "2007-12-03T10:15:30Z",
"duration": 123,
"location_on": BasicLocation,
"location_off": BasicLocation,
"address_on": "abc123",
"address_off": "abc123",
"speed_on": 987,
"speed_off": 987,
"driver_journey_id": 4,
"date": "2007-12-03",
"trace": [Location]
}
PositionValueTimeseriesFloat
Fields
| Field Name | Description |
|---|---|
position - String
|
|
timeseries - [TimeseriesFloatEntry]
|
Example
{
"position": "xyz789",
"timeseries": [TimeseriesFloatEntry]
}
RawCanRecording
Example
{
"id": "4",
"vehicle_id": "4",
"timestamp": "2007-12-03T10:15:30Z",
"can_address": 987,
"can_address_hex": "xyz789",
"can_data": [987],
"can_data_hex": "abc123"
}
Route
Fields
| Field Name | Description |
|---|---|
duration_total - Int
|
|
section_count - Int
|
|
address_start - String
|
|
address_end - String
|
|
timestamp - DateTime
|
|
timestamp_end - DateTime
|
|
duration - Int
|
|
duration_idle - Int
|
|
distance - Int
|
|
fuel_consumption - Int
|
|
fuel_consumption_idle - Int
|
|
electricity_consumption - Int
|
|
electricity_consumption_idle - Int
|
|
distance_coasting - Int
|
|
duration_coasting - Int
|
|
max_recorded_speed - Int
|
|
location_start - BasicLocation
|
|
location_end - BasicLocation
|
|
journeys - [Journey]
|
Example
{
"duration_total": 123,
"section_count": 123,
"address_start": "xyz789",
"address_end": "abc123",
"timestamp": "2007-12-03T10:15:30Z",
"timestamp_end": "2007-12-03T10:15:30Z",
"duration": 987,
"duration_idle": 987,
"distance": 987,
"fuel_consumption": 987,
"fuel_consumption_idle": 987,
"electricity_consumption": 123,
"electricity_consumption_idle": 987,
"distance_coasting": 987,
"duration_coasting": 987,
"max_recorded_speed": 987,
"location_start": BasicLocation,
"location_end": BasicLocation,
"journeys": [Journey]
}
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
"abc123"
TimeseriesBooleanEntry
TimeseriesFloatEntry
TimeseriesIntEntry
TimeseriesJsonEntry
Vehicle
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
short_id - String
|
|
org_short_id - String
|
|
registration_id - String
|
|
registration_country - String
|
|
vin - String
|
|
make - String
|
|
model - String
|
|
production_date - DateTime
|
|
tags - JSON
|
|
device_id - String
|
|
cam_id - String
|
|
updated_at - DateTime
|
|
org_id - ID!
|
|
client_id - ID!
|
|
engine_type - String
|
|
co2_emisisons_per_km - Int
|
|
fueltank_capacity_ml - Int
|
|
battery_capacity_wh - Int
|
|
type - String
|
|
dashboard - [DashboardEntry]
|
|
Arguments
|
|
timeseries - VehicleTimeSeries
|
|
j1939_dtcs - [J1939DTC]
|
|
obd_dtcs - [OBDDTC]
|
|
journey - Journey
|
|
Arguments
|
|
journeys - [Journey]
|
|
routes - [Route]
|
|
daily_summaries - [DailySummary]
|
|
parameter_daily_summaries - [VehicleParameterDailySummary]
|
|
behaviour_events - [BehaviourEvent]
|
|
parameter_state_ranges - [ParameterStateRange]
|
|
video_recordings - [VideoRecording]
|
|
geofence_vehicle_statuses - [GeofenceStatus]
|
|
overspeed_by_road_events - [OverspeedByRoadEvent]
|
|
service_remaining_brake_lining_percents - [PositionValueTimeseriesFloat]
|
|
interior_temperature_degrees_c - [PositionValueTimeseriesFloat]
|
|
fuel_transactions - [FuelTransactionEntry]
|
|
re_raw_can_recording - [RawCanRecording]
|
|
device - Device
|
|
Example
{
"id": "4",
"short_id": "abc123",
"org_short_id": "abc123",
"registration_id": "xyz789",
"registration_country": "abc123",
"vin": "abc123",
"make": "abc123",
"model": "abc123",
"production_date": "2007-12-03T10:15:30Z",
"tags": {},
"device_id": "abc123",
"cam_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"org_id": "4",
"client_id": 4,
"engine_type": "abc123",
"co2_emisisons_per_km": 123,
"fueltank_capacity_ml": 123,
"battery_capacity_wh": 987,
"type": "abc123",
"dashboard": [DashboardEntry],
"timeseries": VehicleTimeSeries,
"j1939_dtcs": [J1939DTC],
"obd_dtcs": [OBDDTC],
"journey": Journey,
"journeys": [Journey],
"routes": [Route],
"daily_summaries": [DailySummary],
"parameter_daily_summaries": [
VehicleParameterDailySummary
],
"behaviour_events": [BehaviourEvent],
"parameter_state_ranges": [ParameterStateRange],
"video_recordings": [VideoRecording],
"geofence_vehicle_statuses": [GeofenceStatus],
"overspeed_by_road_events": [OverspeedByRoadEvent],
"service_remaining_brake_lining_percents": [
PositionValueTimeseriesFloat
],
"interior_temperature_degrees_c": [
PositionValueTimeseriesFloat
],
"fuel_transactions": [FuelTransactionEntry],
"re_raw_can_recording": [RawCanRecording],
"device": Device
}
VehicleInfo
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
short_id - String
|
|
org_short_id - String
|
|
registration_id - String
|
|
registration_country - String
|
|
vin - String
|
|
make - String
|
|
model - String
|
|
production_date - DateTime
|
|
tags - JSON
|
|
device_id - String
|
|
cam_id - String
|
|
updated_at - DateTime
|
|
org_id - ID!
|
|
client_id - ID!
|
|
engine_type - String
|
|
co2_emisisons_per_km - Int
|
|
fueltank_capacity_ml - Int
|
|
battery_capacity_wh - Int
|
|
type - String
|
Example
{
"id": 4,
"short_id": "abc123",
"org_short_id": "xyz789",
"registration_id": "abc123",
"registration_country": "abc123",
"vin": "abc123",
"make": "abc123",
"model": "xyz789",
"production_date": "2007-12-03T10:15:30Z",
"tags": {},
"device_id": "abc123",
"cam_id": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"org_id": 4,
"client_id": 4,
"engine_type": "xyz789",
"co2_emisisons_per_km": 123,
"fueltank_capacity_ml": 123,
"battery_capacity_wh": 987,
"type": "abc123"
}
VehicleParameterDailySummary
Example
{
"id": "4",
"vehicle_id": "4",
"timestamp": "2007-12-03T10:15:30Z",
"date": "2007-12-03",
"table_name": "xyz789",
"value_first": 123.45,
"value_last": 123.45,
"value_max": 123.45,
"value_min": 987.65,
"value_count": 123,
"value_avg": 987.65
}
VehicleTimeSeries
Fields
| Field Name | Description |
|---|---|
wiper_state - [TimeseriesBooleanEntry]
|
|
ignition_state - [TimeseriesBooleanEntry]
|
|
service_mil - [TimeseriesBooleanEntry]
|
|
device_dmas_connect_state - [TimeseriesBooleanEntry]
|
|
device_external_power_source_connect_state - [TimeseriesBooleanEntry]
|
|
service_indicator - [TimeseriesBooleanEntry]
|
|
service_garage_mode_state - [TimeseriesBooleanEntry]
|
|
battery_voltage_volts - [TimeseriesFloatEntry]
|
|
coolant_temperature_degrees_c - [TimeseriesFloatEntry]
|
|
ambient_air_temperature_degrees_c - [TimeseriesFloatEntry]
|
|
fuel_dashboard_percents - [TimeseriesFloatEntry]
|
|
ev_charge_level_percents - [TimeseriesFloatEntry]
|
|
ev_battery_hv_voltage_volts - [TimeseriesFloatEntry]
|
|
service_distance_from_last_service_meters - [TimeseriesFloatEntry]
|
|
fuel_dashboard_ml - [TimeseriesIntEntry]
|
|
ev_charge_level_wh - [TimeseriesIntEntry]
|
|
mileage_dashboard_meters - [TimeseriesIntEntry]
|
|
mileage_gps_meters - [TimeseriesIntEntry]
|
|
service_adblue_remaining_distance_meters - [TimeseriesIntEntry]
|
|
service_mileage_to_next_inspection_meters - [TimeseriesIntEntry]
|
|
service_distance_to_oil_change_meters - [TimeseriesIntEntry]
|
|
raw_inertial_data - [TimeseriesJsonEntry]
|
Example
{
"wiper_state": [TimeseriesBooleanEntry],
"ignition_state": [TimeseriesBooleanEntry],
"service_mil": [TimeseriesBooleanEntry],
"device_dmas_connect_state": [TimeseriesBooleanEntry],
"device_external_power_source_connect_state": [
TimeseriesBooleanEntry
],
"service_indicator": [TimeseriesBooleanEntry],
"service_garage_mode_state": [TimeseriesBooleanEntry],
"battery_voltage_volts": [TimeseriesFloatEntry],
"coolant_temperature_degrees_c": [TimeseriesFloatEntry],
"ambient_air_temperature_degrees_c": [
TimeseriesFloatEntry
],
"fuel_dashboard_percents": [TimeseriesFloatEntry],
"ev_charge_level_percents": [TimeseriesFloatEntry],
"ev_battery_hv_voltage_volts": [TimeseriesFloatEntry],
"service_distance_from_last_service_meters": [
TimeseriesFloatEntry
],
"fuel_dashboard_ml": [TimeseriesIntEntry],
"ev_charge_level_wh": [TimeseriesIntEntry],
"mileage_dashboard_meters": [TimeseriesIntEntry],
"mileage_gps_meters": [TimeseriesIntEntry],
"service_adblue_remaining_distance_meters": [
TimeseriesIntEntry
],
"service_mileage_to_next_inspection_meters": [
TimeseriesIntEntry
],
"service_distance_to_oil_change_meters": [
TimeseriesIntEntry
],
"raw_inertial_data": [TimeseriesJsonEntry]
}
VideoMedia
VideoRecording
Example
{
"id": "4",
"vehicle_id": 4,
"cam_id": "abc123",
"duration": 987,
"media": [VideoMedia],
"timestamp": "2007-12-03T10:15:30Z",
"request_type": "abc123",
"trigger": "xyz789",
"event_timestamp": "2007-12-03T10:15:30Z",
"size": 987
}