Breadcrumb Report

This API allows the user to view the breadcrumb report.

{
    "startDate": "2022-10-19T05:00:00.000Z",
    "endDate": "2022-10-20T04:59:00.000Z",
    "index": 0,
    "size": 100,
    "browserTimezone": "Canada/Central",
    "desc": false,
    "sortField": "locationTimeInDTZ",
    "filter": {
        "orFilter": {
            "vehicleId": [
                "6d28e2be-324d-11ed-8df5-cd27b898ed07"
            ]
        }
    }
}

API Response explanation

Field

Description

Data Type

result

Array of elements related to the location and vehicle

String

locationStoreId

Unique identifier representing the location data

String

deviceSerial

Serial number of the device associated with the vehicle

String

deviceId

Unique identifier representing the device

String

vehicleId

Unique identifier representing the vehicle/trackee

String

vehicleName

Name of the vehicle

String

groupId

Unique identifier representing the group

String

groupName

Name of the group

String

customerId

Unique identifier representing the customer

Long

locationTime

Time of the event in local timezone

String

tripNumber

Count of trips taken by the vehicle

int

address

Address of the location

String

locality

Locality of the location

String

city

City of the location

String

state

State of the location

String

zipCode

Zipcode of the location

String

country

Countr

String

odometer

Odometer value in Miles/KM based on the account preference set

String

batteryPercentage

For Azuga internal use

String

fixQuality

This indicates the quality of the lat/lon captured. Fix quality = 0,1 indicates good quality and 2 indicates poor quality

Int

processed

For Azuga internal use

boolean

connected

For Azuga internal use

boolean

offsetChanged

For Azuga internal use

boolean

offset

For Azuga internal use

int

insideHOO

For Azuga internal use

boolean

protocolVersionId

For Azuga internal use

int

vehicleProtocolId

For Azuga internal use

int

duplicate

For Azuga internal use

boolean

scheduled

For Azuga internal use

boolean

userName

Name of the driver

String

imei_meid

IMEI number of the SIM

String

userId

Unique identifier representing the driver

String

deviceTypeId

Unique identifier representing the device type.

1 = Datalogger
6 = Asset Tracker

int

assetNo

For Azuga internal use

Double

vProtocolIdChange

For Azuga internal use

boolean

latitude

Latitude of the location

Double

longitude

Longitude of the location

Double

stateId

For Azuga internal use

int

obdSpeed

Speed of the vehicle in Kms

Integer

sog

For Azuga internal use

int

cog

For Azuga internal use

Short

sv

For Azuga internal use

Integer

hdop

For Azuga internal use

Integer

obdMaxSpeed

Maximum speed attained by the vehicle during the trip

Integer

tripDistance

For Azuga internal use

Double

createdAt

Event created time in GMT(event received in Azuga server)

Date

updatedAt

Event updated time in GMT(event updated in Azuga server)

Date

obdAverageSpeed

For Azuga internal use

Integer

eventName

Name of the event

String

trackeeTypeId

Unique identifier representing the vehicle type
1 = Vehicle
3 = Asset

Short

tripIdlingTime

Idling time in seconds during the trip

Integer

eventType

Name of the event type

String

tripStateId

Unique identifier representing the trip state

0 = Stopped
1 = Moving
2 = Idling
3 = Over Speeding

Byte

prevFuelLevel

For Azuga internal use

int

newFuelLevel

For Azuga internal use

int

speedLimit

The posted speed limit of the location. The unit of this field can be KPH or MPH based on the account preference.

String

locationTimeInDTZ

Location time in device timezone

Date

timeZone

Timezone of the device/vehicle

String

locationStagingId

For Azuga internal use

String

ignored

For Azuga internal use

boolean

speedCombine

For Azuga internal use

String

parentGroupId

Unique identifier representing the parent group

String

parentGroupName

Name of the parent group

String

initialOdometerSet

Initial odometer value set for the vehicle

byte

seatBeltSupport

Boolean value representing the seatbelt support.
True = Support seatbelt
False = Doesn't support seatbelt

boolean

odoSupport

Boolean value representing the odo support.
True = Support odometer
False = Doesn't support odometer

boolean

ioxSupportDevice

For Azuga internal use

boolean

location

Location coordinates

Object

triggerValue

For Azuga internal use

Integer

videoLinks

For Azuga internal use

String

potCrash

For Azuga internal use

boolean

bumpCrash

For Azuga internal use

boolean

pushPopCrash

For Azuga internal use

boolean

standStillCrash

For Azuga internal use

boolean

spikeOnlyCrash

For Azuga internal use

boolean

mileage

For Azuga internal use

int

crash

For Azuga internal use

boolean

virtualTripEnd

For Azuga internal use

boolean

lowTirePressureEvent

For Azuga internal use

boolean

pages

Information related to results page and pagination.

  1. First: Boolean Value denoting whether the first page has successfully added the results
  2. totalElements: Total number of Vehicle ID elements.
  3. elementsFetched: Number of search results fetched that match the filters
    pageNumber: Number of pages required to display the entire result set.

Object

preferences

Preferences set by the user to generate the breadcrumbs report.

Language
Credentials
Header
Click Try It! to start a request and see the response here!