Device Data API Endpoints
Last updated
Last updated
This is a deprecated API
https://device-data-api.dimo.zone
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/status
Retrieves vehicle-related status data from the user device. Regardless of connection type, this attempts to fetch information from the devices that the API user owns.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/historical
Retrieves vehicle-related history data from the user device. Regardless of connection type, this attempts to fetch information from the devices that the API user owns.
POST
{baseUrl}
/v1/user/device-data/{userDeviceId}/export/json/email
Enqueues a data export job for the user device identified by the userDeviceId
. A link to download a JSON file of signals will be emailed to the address on file for the API user. This email is defined under the email.address
if you look up the authenticated API user.
DIMO Warning
This endpoint will be deprecated for non-J1939 developers, please use Telemetry API References instead. For J1939 protocol developers, please reach out to the DIMO team to retain access to this API.
To access the Vehicle data under the Device Data API, a token exchange transaction is required to obtain a 2nd JWT to get permission to access a given vehicle. Please check Token Exchange API prior to using this endpoint.
GET
{baseUrl}
/v1/vehicle/{tokenId}/status
Retrieves the Vehicle Status by the Vehicle identified with the provided Vehicle ID.
GET
{baseUrl}
/v1/vehicle/{tokenId}/status-raw
Retrieves the Vehicle Raw Status by the Vehicle identified with the provided Vehicle ID.
GET
{baseUrl}
/v1/vehicle/{tokenId}/history
Retrieves the Vehicle History by the Vehicle identified with the provided Vehicle ID.
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/daily-distance
Retrieves a daily summary of distances driven (in kilometers) tracked on the user device.
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/distance-driven
Retrieves a total distance driven (in kilometers) tracked on the user device since connection was established. Returns 0
if no odometer data was ever received.
This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
userDeviceId*
String
For userDeviceId
, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token
generated from the Web3 challenge.
userDeviceId*
String
For userDeviceId
, please refer to the User Device entity under Devices API.
startDate
String
Starting timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
endDate
String
Ending timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to today if not specified.
Authorization*
String
Bearer authentication using the access_token
generated from the Web3 challenge.
userDeviceId*
String
For userDeviceId
, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token
generated from the Web3 challenge.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token
that is permitted to access trips data for this specific vehicle.
Authorization*
String
Bearer authentication using the token
generated from the Token Exchange.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token
that is permitted to access trips data for this specific vehicle.
Authorization*
String
Bearer authentication using the token
generated from the Token Exchange.
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token
that is permitted to access trips data for this specific vehicle.
startDate
String
Starting timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
endDate
String
Ending timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to today if not specified.
Authorization*
String
Bearer authentication using the token
generated from the Token Exchange.
userDeviceId*
String
For userDeviceId
, please refer to the User Device entity under Devices API.
time_zone*
String
Timezone in TZ Identifier format. Common examples are America/Los_Angeles
and America/New_York
; etcetera source files (Etc/GMT-0
) is also supported.
Authorization*
String
Bearer authentication using the access_token
generated from the Web3 challenge.
userDeviceId*
String
For userDeviceId
, please refer to the User Device entity under Devices API.
Authorization*
String
Bearer authentication using the access_token
generated from the Web3 challenge.