Trip
Get List Of Trips
The endpoint is designed to handle requests for retrieving or fetching information about trips or journeys. It allows users to access details related to various trips that may have been recorded in the system.
Success
GET /api/v8/Trip HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
[
{
"id": 1,
"score": 1,
"isCompleted": true,
"createDate": "2025-06-11T08:43:35.461Z",
"originAddress": "text",
"originPostalCode": "text",
"originLocality": "text",
"originPlace": "text",
"originRegion": "text",
"origin": "text",
"destinationAddress": "text",
"destinationPostalCode": "text",
"destinationLocality": "text",
"destinationPlace": "text",
"destinationRegion": "text",
"destination": "text",
"startDateTime": "2025-06-11T08:43:35.461",
"endDateTime": "2025-06-11T08:43:35.461",
"duration": "00:30:00",
"transportationType": "Driver",
"iAmDriver": true,
"hasAccident": true
}
]Header Request Parameters
Authentication Bearer Token
Request Query Parameters
keyword: it's a query that is used to search data, and it is expected to be a string value.
NOTE: if the keyword is empty, it will return the whole related data.
Response
The provided endpoint response contains an array of several properties, including:
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
score: the score property represents a score gotten from a trip between 0 to 100. It is expected to be a numeric value, e.g. 70.
isCompleted: the isCompleted property is a Boolean value. This property typically indicates whether uploading files is completed or not, e.g. true means it is completed.
createDate: this property represents the date and time when a trip was created, which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", and it is expected to be a string value, e.g. "2023-07-25T12:12:09.211Z".
originAddress: the originAddress property represents the location where a trip starts. It is expected to be a string value, e.g. "Jülicher Straße".
originPostalCode: this property represents the postal code associated with the origin. It is expected to be a string value, e.g. "52070".
originLocality: the originLocality property represents the locality or city of the origin. It is expected to be a string value, e.g. "Kalkofen".
originPlace: this property represents the name or identifier of the origin. It is expected to be a string value, e.g. "Aachen".
originRegion: the originRegion property represents the region or state of the origin. It is expected to be a string value, e.g. "North Rhine-Westphalia".
origin: the origin property represents the origin location. It is expected to be a string value, e.g. "Kalkofen, Aachen, North Rhine-Westphalia".
destinationAddress: the destinationAddress property represents the location where a trip ends. It is expected to be a string value, e.g. "Roermonder Straße".
destinationPostalCode: this property represents the postal code associated with the destination. It is expected to be a string value, e.g. "52072".
destinationLocality: the destinationLocality property represents the locality or city of the destination. It is expected to be a string value, e.g. "Ponttor".
destinationPlace: this property represents the name or identifier of the destination. It is expected to be a string value, e.g. "Aachen".
destinationRegion: the destinationRegion property represents the region or state of the destination. It is expected to be a string value, e.g. "North Rhine Westphalia".
destination: the destination property represents the destination. It is expected to be a string value, e.g. " Ponttor, Aachen, North Rhine Westphalia".
startDatetime: the startDatetime property represents the date and time when a trip starts. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and is expected to be a string value, e.g. "2023-07-25T15:41:45.282".
endDateTime: this property represents the date and time when a trip ends. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and is expected to be a string value, e.g. "2023-07-25T15:41:57.481".
duration: the duration property is an object that contains sub-properties representing the duration of the trip. These sub-properties include hours, minutes, seconds, and milliseconds, that each of them is expected to be a numeric value. An example of duration can be "00:00:12.199".
transportationType: this property indicates the transportation mode of the trip.
iAmDriver: this property indicates if the user has been the driver during the trip .
hasAccident: This property specifies whether an accident occurred during the trip.
Get Trip By ID
The endpoint is designed to handle requests for retrieving or fetching information about a specific trip or journey based on its unique identifier. It allows users to access detailed information about a particular trip.
Success
GET /api/v8/Trip/{id} HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"id": 1,
"score": 1,
"isCompleted": true,
"originAddress": "text",
"originPostalCode": "text",
"originLocality": "text",
"originPlace": "text",
"originRegion": "text",
"origin": "text",
"destinationAddress": "text",
"destinationPostalCode": "text",
"destinationLocality": "text",
"destinationPlace": "text",
"destinationRegion": "text",
"destination": "text",
"videoStreamPath": "text",
"videoFilePath": "text",
"videoThumbnail": "text",
"tripType": "Full",
"startDateTime": "2025-06-11T08:43:35.465",
"endDateTime": "2025-06-11T08:43:35.465",
"duration": "00:30:00",
"createDate": "2025-06-11T08:43:35.465Z",
"iAmDriver": true,
"carModel": "text",
"carBrand": "text",
"transportationType": "Driver",
"distance": "text"
}Header Request Parameters
Authentication Bearer Token
Request Parameters
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
Response
The provided endpoint response contains several properties, including:
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
score: the score property represents a score gotten from a trip between 0 to 100. It is expected to be a numeric value, e.g. 70.
isCompleted: the isCompleted property is a Boolean value. This property typically indicates whether uploading files is completed or not, e.g. true means it is completed.
originAddress: the originAddress property represents the location where a trip starts. It is expected to be a string value, e.g. "Jülicher Straße".
originPostalCode: this property represents the postal code associated with the origin. It is expected to be a string value, e.g. "52070".
originLocality: the originLocality property represents the locality or city of the origin. It is expected to be a string value, e.g. "Kalkofen".
originPlace: this property represents the name or identifier of the origin. It is expected to be a string value, e.g. "Aachen".
originRegion: the originRegion property represents the region or state of the origin. It is expected to be a string value, e.g. "North Rhine-Westphalia".
origin: the origin property represents the origin location. It is expected to be a string value, e.g. "Kalkofen, Aachen, North Rhine-Westphalia".
destinationAddress: the destinationAddress property represents the location where a trip ends. It is expected to be a string value, e.g. "Roermonder Straße".
destinationPostalCode: this property represents the postal code associated with the destination. It is expected to be a string value, e.g. "52072".
destinationLocality: the destinationLocality property represents the locality or city of the destination. It is expected to be a string value, e.g. "Ponttor".
destinationPlace: this property represents the name or identifier of the destination. It is expected to be a string value, e.g. "Aachen".
destinationRegion: the destinationRegion property represents the region or state of the destination. It is expected to be a string value, e.g. "North Rhine Westphalia".
destination: the destination property represents the destination. It is expected to be a string value, e.g. "Ponttor, Aachen, North Rhine Westphalia".
videoStreamPath: the URL for streaming the video if the trip data contains video.
videoFilePath: the URL for downloading the video if the trip data contains video.
videoThumbnail: the URL for retrieving the video thumbnail if the trip data contains video.
tripType: this property specifies the sensors used for recording the trip.
startDatetime: the startDatetime property represents the date and time when a trip starts. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and is expected to be a string value, e.g. "2023-07-25T15:41:45.282".
endDateTime: this property represents the date and time when a trip ends. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and is expected to be a string value, e.g. "2023-07-25T15:41:57.481".
duration: the duration property is an object that contains sub-properties representing the duration of the trip. These sub-properties include hours, minutes, seconds, and milliseconds, that each of them is expected to be a numeric value. An example of duration can be "00:00:12.199".
createDate: this property represents the date and time when a trip was created, which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", and it is expected to be a string value, e.g. "2023-07-25T12:12:09.211Z".
iAmDriver: this property indicates whether the current user is identified as the driver for the trip, and it is expected to be a boolean value, e.g. true.
carModel: this property represents the model or type of the car used for the trip. It provides information about the specific car model associated with the trip, and it is expected to be a string value, e.g. "Sl350".
carBrand: this property represents the brand or manufacturer of the car used for the trip. It provides information about the specific car brand associated with the trip, and it is expected to be a string value, e.g. "Benz".
transportationType: this property indicates the transportation mode of the trip.
distance: the mileage of the trip in kilometers.
Get Trip Route By Trip ID
The endpoint is designed to handle requests for retrieving GPS data associated with a specific trip. It allows users to access route coordinates and driving events such as harsh braking, harsh acceleration, phone interactions, and more during the trip. This information can be used to display the trip route and the locations of driving events on a map.
Success
GET /api/v8/Trip/{id}/gps HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"gpsDetail": [
{
"gpsTime": "2025-06-11T08:43:35.462",
"latitude": 1,
"longitude": 1,
"speedingSeverity": 1,
"color": "text"
}
],
"events": [
{
"eventType": "HarshAccel",
"eventName": "text",
"location": {
"latitude": 1,
"longitude": 1,
"address": "text"
}
}
]
}Header Request Parameters
Authentication Bearer Token
Request Parameters
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
Response
The provided endpoint response contains several properties, including:
gpsDetail: the gpsDetail property is an array that contains objects representing GPS information. Each object within the array includes properties, i.e. gpsTime, latitude, and longitude.
gpsTime: this key-value pair indicates the GPS time, which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS". It is expected to be a string value, e.g. "2023-08-29T21:06:47.002".
latitude: this key-value pair represents the latitude coordinate as a numeric value, e.g. 50.781810.
longitude: this key-value pair represents the longitude coordinate as a numeric value, e.g. 6.070963.
speedingSeverity: an integer indicating the extent of speeding. Higher values mean more severe speeding.
color: the default (suggested) color to show the corresponding point of the route on the map.
events: the events property is an array that contains objects representing events associated with the GPS data. Each object within the array includes properties such as eventType, eventName, latitude, and longitude. These properties provide details about the event type and its associated GPS coordinates.
eventType: this key-value pair represents the type of event as a numeric value, e.g. 0.
0
Harsh Accel
1
Harsh Brake
2
Harsh Corner
10
Focus
eventName: this key-value pair represents the name or description of the event as a string value, e.g. "Harsh and sudden acceleration".
location: this key-value pair provides information about the specific geographical location of the user. It includes details such as latitude, longitude, and an address associated with that location.
latitude: the latitude represents the latitude coordinate as a numeric value, e.g. 50.767870.
longitude: the longitude represents the longitude coordinate as a numeric value, e.g. 6.104236.
address: the address provides an address associated with the location. It may include information such as the street name, building number, city, state, and postal code.
Get the Last Driving Trip
The endpoint is designed to handle requests for retrieving or fetching the information of the last driving trip recorded in the system. It allows users to access details about the most recent driving trip registered in the system.
Success
GET /api/v1/Trip/last-driving-trip HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"id": 1,
"createDate": "2025-08-23T20:09:13.464Z",
"startDateTime": "2025-08-23T20:09:13.464",
"endDateTime": "2025-08-23T20:09:13.464",
"duration": "00:30:00",
"origin": "text",
"destination": "text",
"originPlace": "text",
"destinationPlace": "text",
"score": 1,
"transportationType": "Driver",
"gpsInfo": [
{
"gpsTime": "2025-08-23T20:09:13.464",
"altitude": 1,
"latitude": 1,
"longitude": 1,
"speed": "text",
"climb": "text",
"course": "text",
"epx": "text",
"epy": "text",
"epv": "text",
"eps": "text",
"epc": "text",
"epd": "text",
"speedingSeverity": 1,
"color": "text"
}
]
}Header Request Parameters
Authentication Bearer Token
Response
The provided endpoint response contains several properties, including:
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
craeteDate: this property represents the date and time when a trip was created which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", and is expected to be a string value, e.g. "2023-07-25T12:12:09.211Z".
startDateTime: the startDateTime property represents the date and time when a trip starts. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:45.282".
endDateTime: this property represents the date and time when a trip ends. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:57.481".
duration: the duration property is an object that contains sub-properties representing the duration of the trip. These sub-properties include hours, minutes, seconds, and milliseconds that each of them is expected to be a numeric value. An example of duration can be "00:00:12.199".
origin: the origin property represents the origin. It is expected to be a string value, e.g. "Kalkofen, Aachen, North Rhine-Westphalia".
destination: the destination property represents the destination. It is expected to be a string value, e.g. " Ponttor, Aachen, North Rhine Westphalia".
originPlace: this property represents the name or identifier of the origin. It is expected to be a string value, e.g. "Aachen".
destinationPlace: this property represents the name or identifier of the destination. It is expected to be a string value, e.g. "Aachen".
score: the score property represents a score gotten from a trip that is between 0 to 100. It is expected to be a numeric value, e.g. 70.
gpsInfo: the gpsInfo property is an array containing GPS information, which includes:
gpsTime: The gpsTime shows the date and time of the GPS information in the format "yyyy-MM-dd'T'HH:mm:ss.SSS". It is expected to be a string value, e.g. "2023-08-29T20:54:56.833".
altitude: the altitude property represents the altitude above sea level in meters. It is expected to be a numeric value, e.g. 215.5.
latitude: the latitude property represents the latitude of the current location in degrees. It is expected to be a numeric value, e.g. 50.767002.
longitude: the longitude property represents the longitude of the current location in degrees. It is expected to be a numeric value, e.g. 6.103598.
speed: the speed property represents the speed value in kph. It is expected to be a string value, e.g. 38.
climb: the climb property represents the climb value in m/s. It is expected to be a string value, e.g. 0.0.
course: the course property represents the course value in degrees determined clockwise with respect to the geographical North. It is expected to be a string value, e.g. 280.8201.
epx: the epx property represents the estimated position error along the X-axis. It is expected to be a string value, e.g. 0.000001.
epy: the epy property represents the estimated position error along the Y-axis. It is expected to be a string value, e.g. 0.000001.
epv: the epv property represents the estimated vertical position error. It is expected to be a string value, e.g. 3.0.
eps: the eps property represents the estimated speed error. It is expected to be a string value, e.g. 0.5.
epc: the epc property represents the estimated climb error. It is expected to be a string value, e.g. 1.0.
epd: the epd property represents the estimated course error. It is expected to be a string value, e.g. 0.1000.
Get the Last Driving Trip
The endpoint is designed to handle requests for retrieving or fetching the information of the last driving trip recorded in the system. It allows users to access details about the most recent trip registered in the system.
Success
GET /api/v1/Trip/last-driving-trip HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"id": 1,
"createDate": "2025-08-23T20:09:13.464Z",
"startDateTime": "2025-08-23T20:09:13.464",
"endDateTime": "2025-08-23T20:09:13.464",
"duration": "00:30:00",
"origin": "text",
"destination": "text",
"originPlace": "text",
"destinationPlace": "text",
"score": 1,
"transportationType": "Driver",
"gpsInfo": [
{
"gpsTime": "2025-08-23T20:09:13.464",
"altitude": 1,
"latitude": 1,
"longitude": 1,
"speed": "text",
"climb": "text",
"course": "text",
"epx": "text",
"epy": "text",
"epv": "text",
"eps": "text",
"epc": "text",
"epd": "text",
"speedingSeverity": 1,
"color": "text"
}
]
}Header Request Parameters
Authentication Bearer Token
Response
The provided endpoint response contains several properties, including:
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
craeteDate: this property represents the date and time when a trip was created which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", and is expected to be a string value, e.g. "2023-07-25T12:12:09.211Z".
startDateTime: the startDateTime property represents the date and time when a trip starts. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:45.282".
endDateTime: this property represents the date and time when a trip ends. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:57.481".
duration: the duration property is an object that contains sub-properties representing the duration of the trip. These sub-properties include hours, minutes, seconds, and milliseconds that each of them is expected to be a numeric value. An example of duration can be "00:00:12.199".
origin: the origin property represents the origin. It is expected to be a string value, e.g. "Kalkofen, Aachen, North Rhine-Westphalia".
destination: the destination property represents the destination. It is expected to be a string value, e.g. " Ponttor, Aachen, North Rhine Westphalia".
originPlace: this property represents the name or identifier of the origin. It is expected to be a string value, e.g. "Aachen".
destinationPlace: this property represents the name or identifier of the destination. It is expected to be a string value, e.g. "Aachen".
score: the score property represents a score gotten from a trip that is between 0 to 100. It is expected to be a numeric value, e.g. 70.
gpsInfo: the gpsInfo property is an array containing GPS information, which includes:
gpsTime: The gpsTime shows the date and time of the GPS information in the format "yyyy-MM-dd'T'HH:mm:ss.SSS". It is expected to be a string value, e.g. "2023-08-29T20:54:56.833".
altitude: the altitude property represents the altitude above sea level in meters. It is expected to be a numeric value, e.g. 215.5.
latitude: the latitude property represents the latitude of the current location in degrees. It is expected to be a numeric value, e.g. 50.767002.
longitude: the longitude property represents the longitude of the current location in degrees. It is expected to be a numeric value, e.g. 6.103598.
speed: the speed property represents the speed value in kph. It is expected to be a string value, e.g. 38.
climb: the climb property represents the climb value in m/s. It is expected to be a string value, e.g. 0.0.
course: the course property represents the course value in degrees determined clockwise with respect to the geographical North. It is expected to be a string value, e.g. 280.8201.
epx: the epx property represents the estimated position error along the X-axis. It is expected to be a string value, e.g. 0.000001.
epy: the epy property represents the estimated position error along the Y-axis. It is expected to be a string value, e.g. 0.000001.
epv: the epv property represents the estimated vertical position error. It is expected to be a string value, e.g. 3.0.
eps: the eps property represents the estimated speed error. It is expected to be a string value, e.g. 0.5.
epc: the epc property represents the estimated climb error. It is expected to be a string value, e.g. 1.0.
epd: the epd property represents the estimated course error. It is expected to be a string value, e.g. 0.1000.
Get Last Trip
The endpoint is designed to handle requests for retrieving or fetching the information of the last trip recorded in the system regardless of the used mean of transportation. It allows users to access details about the most recent trip registered in the system.
Success
GET /api/v9/Trip/last HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"id": 1,
"createDate": "2025-06-11T08:43:54.131Z",
"startDateTime": "2025-06-11T08:43:54.132",
"endDateTime": "2025-06-11T08:43:54.132",
"duration": "00:30:00",
"origin": "text",
"destination": "text",
"originPlace": "text",
"destinationPlace": "text",
"score": 1,
"transportationType": "Driver",
"gpsInfo": [
{
"gpsTime": "2025-06-11T08:43:54.132",
"altitude": 1,
"latitude": 1,
"longitude": 1,
"speed": "text",
"climb": "text",
"course": "text",
"epx": "text",
"epy": "text",
"epv": "text",
"eps": "text",
"epc": "text",
"epd": "text",
"speedingSeverity": 1,
"color": "text"
}
]
}Header Request Parameters
Authentication Bearer Token
Response
The provided endpoint response contains several properties, including:
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
craeteDate: this property represents the date and time when a trip was created which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", and is expected to be a string value, e.g. "2023-07-25T12:12:09.211Z".
startDateTime: the startDateTime property represents the date and time when a trip starts. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:45.282".
endDateTime: this property represents the date and time when a trip ends. It is formatted as ""yyyy-MM-dd'T'HH:mm:ss.SSS", and it is expected to be a string value, e.g. "2023-07-25T15:41:57.481".
duration: the duration property is an object that contains sub-properties representing the duration of the trip. These sub-properties include hours, minutes, seconds, and milliseconds that each of them is expected to be a numeric value. An example of duration can be "00:00:12.199".
origin: the origin property represents the origin. It is expected to be a string value, e.g. "Kalkofen, Aachen, North Rhine-Westphalia".
destination: the destination property represents the destination. It is expected to be a string value, e.g. " Ponttor, Aachen, North Rhine Westphalia".
originPlace: this property represents the name or identifier of the origin. It is expected to be a string value, e.g. "Aachen".
destinationPlace: this property represents the name or identifier of the destination. It is expected to be a string value, e.g. "Aachen".
score: the score property represents a score gotten from a trip that is between 0 to 100. It is expected to be a numeric value, e.g. 70.
gpsInfo: the gpsInfo property is an array containing GPS information, which includes:
gpsTime: The gpsTime shows the date and time of the GPS information in the format "yyyy-MM-dd'T'HH:mm:ss.SSS". It is expected to be a string value, e.g. "2023-08-29T20:54:56.833".
altitude: the altitude property represents the altitude above sea level in meters. It is expected to be a numeric value, e.g. 215.5.
latitude: the latitude property represents the latitude of the current location in degrees. It is expected to be a numeric value, e.g. 50.767002.
longitude: the longitude property represents the longitude of the current location in degrees. It is expected to be a numeric value, e.g. 6.103598.
speed: the speed property represents the speed value in kph. It is expected to be a string value, e.g. 38.
climb: the climb property represents the climb value in m/s. It is expected to be a string value, e.g. 0.0.
course: the course property represents the course value in degrees determined clockwise with respect to the geographical North. It is expected to be a string value, e.g. 280.8201.
epx: the epx property represents the estimated position error along the X-axis. It is expected to be a string value, e.g. 0.000001.
epy: the epy property represents the estimated position error along the Y-axis. It is expected to be a string value, e.g. 0.000001.
epv: the epv property represents the estimated vertical position error. It is expected to be a string value, e.g. 3.0.
eps: the eps property represents the estimated speed error. It is expected to be a string value, e.g. 0.5.
epc: the epc property represents the estimated climb error. It is expected to be a string value, e.g. 1.0.
epd: the epd property represents the estimated course error. It is expected to be a string value, e.g. 0.1000.
Get Trip Event Stats By ID
The endpoint is designed to handle requests for retrieving or fetching event statistics related to a specific trip. It allows users to access aggregated data or metrics about various events that occurred during the trip.
Success
GET /api/v6/Trip/{id}/eventStats HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
[
{
"eventType": "HarshAccel",
"eventName": "text",
"eventDescription": "text",
"scorePercentile": 1,
"events": [
{
"title": "text",
"description": "text",
"extraDescription": [
"text"
],
"videoUrl": "text",
"videoThumbnailUrl": "text"
}
]
}
]Header Request Parameters
Authentication Bearer Token
Request Parameters
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
Response
The provided endpoint response contains an array of several properties, including:
eventType: the eventType property represents the type of event that occurred, and it is expected to be a numeric value, e.g. 3.
0
Harsh Accel
1
Harsh Brake
2
Harsh Corner
10
Focus
eventName: the eventName property represents the name or description of the event as a string value, e.g. "Speeding Score".
eventDescription: The eventDescription property provides a description or summary of the event type. It is expected to be a string value, e.g. "Driving over the speed limit".
scorePercentile: the scorePercentile property represents the percentile rank of the score achieved for the event. It is expected to be a numeric value, e.g. 95.
events: the events property is an array that contains objects representing specific events. Each event object includes properties such as title, description, extraDescription, videoUrl, and videoThumbnailUrl. These properties provide details about the event's name, details, location of the video, and location of a thumbnail image associated with the video.
title: this key-value pair represents the title or name of the event, and it is expected to be a string value, e.g. "Speeding 8% of the trip".
description: this key-value pair provides a description or summary of the event, and it is expected to be a string value, e.g. "Night time driving: 0:0:0".
extraDescription: this key-value pair is an array of strings that provides additional details or information about the event, e.g. "Rush hour driving: 0:0:0" and "Weekend time driving: 0:0:0"
videoUrl: this key-value pair represents the URL or location of a video associated with the event, and it is expected to be a string value.
videoThumbnailUrl: this key-value pair represents the URL or location of a thumbnail image for the video associated with the event, and it is expected to be a string value.
Get Last Trip Carbon
The endpoint is designed to handle requests for retrieving or fetching the carbon emissions or carbon footprint of the most recent trip recorded in the system. It allows users to access information about the environmental impact in terms of carbon emitted as a result of a trip.
Success
GET /api/v1/Trip/lastTripCarbon HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Accept: */*
Success
{
"carbon": 1,
"lastUpdate": "2025-08-23T20:09:13.466"
}Header Request Parameters
Authentication Bearer Token
Response
The provided endpoint response contains several properties, including:
carbon: the carbon property represents the amount of carbon emissions in kilogram during a trip. It is expected to be a numeric value, e.g. 0.72.
lastUpdate: the lastUpdate property indicates the date and time when the carbon emission information was updated, which is formatted as "yyyy-MM-dd'T'HH:mm:ss.SSS". It is expected to be a string value, e.g. "2023-08-29T20:54:56.836".
Success
PATCH /api/v8/Trip/{id}/IAmDriver HTTP/1.1
Host: api.artificient.de
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"nonDrivingTripType": "Driver",
"iAmDriver": true
}Success
{
"id": 1
}Transportation Mode
The endpoint is designed to allow the user to report the mode of transportation for trip.
Header Request Parameters
Authentication Bearer Token
Request Parameters
id: the id property represents an identifier or reference to a trip. It is expected to be a numeric value, e.g. 1002.
Request Query Parameters
nonDrivingTripType: the nonDrivingTripType property represents the type of non-driving trip the user is undertaking. it includes options like "Subway", "Train", "Walking", "Tram", "Bus", "Bike", and "Passenger". See the table below for the corresponding values.
Driving
0
Passenger
1
Subway
2
Train
3
Walking
4
Tram/Subway
5
Bus
6
Bike
7
iAmDriver: the iAmDriver parameter indicates whether the user is acting as a driver in the specified trip. If set to true, it means the user is the driver; if set to false, it means the user is not the driver.
Response
The provided endpoint response contains several properties, including:
id: the id property represents the identifier associated with the response. It indicates the outcome of the operation or the specific trip's ID. It is expected to be a numeric value, e.g. 1002.
Last updated