Terms and Definitions
Learn about the terms and definitions for each module.
Platform
| API term | UI term | Definition |
|---|---|---|
| AsOfDate | N/A | Month of the base map version used. |
| CityId | City ID | Unique identifier for a city. Typically, the FIPS code. |
| CountyId | County ID | Unique identifier for a county. Typically, the FIPS code or Canadian census subdivision CSDUID from StatCan. |
| DateRanges | TBD | User input date ranges for filtering. Array of objects containing DateFrom (date) and DateTo (date). |
| DaysOfWeek | Days of the Week | Integers representing each week day. 1 = Sunday, 2 = Monday, etc. |
| Distance | Distance | The distance traveled (in kilometers or miles). |
| DwellTime | Dwell Time | The amount of time spent at a destination (in minutes). |
| FuelTypeFilter | N/A | User input fuel type filter. |
| FuelTypes | TBD | The fuel types that you can select for your analyses. Options include diesel, electric, flexible, gasoline, hybrid, other, and unknown. See Fuel Types to read a description of each option. |
| Geography | TBD | The geospatial bounds of an area of interest. |
| Idle | N/A | The vehicle is running and is stationary |
| IdleDuration | Idle Duration |
Describes the idle duration of a vehicle This includes the following API terms:
|
| Industry | Industry Breakdown | The percentage of journeys by industry as defined by the primary NAICS code. The primary NAICS code is determined by the fleet operating the vehicle that is contributing to the data. |
| IsMetric | N/A | Whether the user specified to compute things in metric (TRUE) or imperial (FALSE) units. |
| ISO_3166_2 | N/A | The state ISO code of the returned zone. |
| MetricsByIndustry | N/A | Metrics broken out by industry NAICS code. |
| MetricsByVehicleClass | N/A | Metrics broken out by vehicle class. |
| MetricsByVocation | N/A | Metrics broken out by vehicle vocation. |
| NAICS | NAICS1 | Integers representing industry IDs. See the Industry table for specific industry codes. |
| Polygon | N/A | Geojson string of the zone. |
| ReferenceDate | TBD | The most up-to-date day of OSM when the base map used was generated. |
| RoadTypes | TBD | Array of strings representing the different road types for which you want data. An empty array means all road types. |
| SegmentId | Segment Id | A unique identifier for the road segment which can be obtained from the API to get segment IDs can be found in the API Guide. |
| StopDuration | Stop Duration |
Describes the stop duration of a vehicle. This includes the following API terms:
|
| TimeRange | TBD | User input time range for filtering. Object containing TimeFrom (time) and TimeTo (time). |
| TravelSpeed | Travel Speed | The vehicle speed when traveling between areas of interest (in kph or mph). Travel speed is calculated as the total distance traveled divided by the duration it takes to travel the distance (including idling time). This includes the following API terms:
|
| TravelTime | Travel Time | The time taken to travel between areas of interest, including any time stopped (in kph or mph). |
| Trip | Trip | When a vehicle starts moving until it stops with ignition turned off, or idles for at least 3 minutes, 20 seconds. |
| TripCount | Number of Trips | The number of observed trips. |
| VehicleClass | Vehicle Class Breakdown | The percentage of journeys by vehicle class as defined by GVWR. |
| VehicleClasses | TBD | An array of vehicle class objects where each object contains VehicleType and WeightClass. |
| VehicleClassSchemeId | TBD | User input vehicle class scheme ID. |
| VehicleCount | TBD | The number of unique vehicles contributing to the stop count. |
| Vocation | Vocation Breakdown | The percentage of journeys by vocation. |
| Vocation | Vocation | The purpose (or job) of the vehicle. A Geotab patented machine learning algorithm determines this based on the observed driving pattern of each vehicle. |
| WayId | Way ID | A collection of nodes defined by OpenStreetMap. |
| ZoneDescription | TBD | Description of the zone when available, such as road name. |
| ZoneId | Zone ID | A unique identifier for the zone; can be any string. |
| Zones | Custom Zones | An enclosed area on the map, created by a user, used to categorize a landmark or area of interest. |
| ZoneType | Zone Type | Defines the type zone. Utilized to classify standard zones (e.g. county, city), custom zones and segments. |
Origin and Destination
| API term | UI term | Definition |
|---|---|---|
| Connector | Connector | A location that is passed through on an analysis between the O and D. |
| Destination | Destination | Where an analysis or journey ends. |
| JourneyDuration | Journey Duration | The travel time between the O/D pair (in minutes). |
| DurationAtDestination | Time at Destination | The amount of time spent at the destination until the next journey (in minutes). |
| InterTripStopDuration | Intra-Journey Stop Duration |
The total stop time for a journey (sum of all stop times between trips that comprise a journey) (in minutes). If no trip chaining factor was used, this value will be 0. This includes the following API terms:
|
| JourneyCount | Journey Count | The number of journeys between the O/D pair that met the criteria of your analysis. |
| Origin | Origin | Where an analysis or journey begins. |
| Passthrough | Passthrough | Begin/end analysis of a journey at selected zones, even if the journey didn’t necessarily start/end at these locations. |
| RadiusSelection | Radius | A tool that allows you to define a zone type and geographic radius, then view all zones that fit that criteria. |
| RunningSpeed | Running Speed |
The vehicle speed when traveling between areas of interest (in kph or mph). Running speed is calculated using only the time the vehicle is moving (excludes time idling or stopped). This includes the following API terms:
|
| JourneyTripCount | Journey Trip Count | The number of trips comprising the journey between the O/D pair. If no trip chaining factor was used, this value will be 1. |
Route Analytics
| API term | UI term | Definition |
|---|---|---|
| JourneyPercentCountOfTotal | Journey Percentage of Total Journeys | The percentage of journeys between the O/D pair relative to the total amount of journeys for the entire analysis. |
| RouteGroupingThreshold | N/A | The percent similarity threshold for grouping sub-routes under a main route. For example, 0.90 means that routes that are 90% similar will be grouped together. (defaults to 0.90 if not provided). |
| TripChainDuration | Trip Chaining | Algorithm that allows the user to chain together trips into a single journey. This is based on a user defined minimum stop duration threshold. All stops that are less than the threshold defined are ignored, and the next trip is chained to the previous one to give the user the opportunity to see the true origins and destinations. |
Stop Analytics
| API term | UI term | Definition |
|---|---|---|
| AggregationMode | TBD | Geographic aggregation mode. |
| DomDCCount | TBD | Total number of domicile duty cycles for eligible vehicles that have their domicile in the zone, calculated as a summation of domicile duty cycles across all eligible vehicles. |
| DomDCDistance | TBD |
The domicile duty cycle distance. This includes the following API terms:
|
| DomDCDuration | TBD |
The domicile duty cycle duration. This includes the following API terms:
|
| DomStopDuration | TBD |
The duration stopped at the domicile. This includes the following API terms:
|
| EligibilityCriteria | TBD |
Eligibility criteria for an analysis. This includes any of the following:
|
| EligibleDomVehicleCount | N/A | The number of vehicles that meet vehicle filters, have their domicile in the analysis zone and are also deemed eligible for the analysis period based on input eligibility criteria. |
| NonDomStopDuration | TBD |
The duration stopped at a non-domicile. This includes the following API terms:
|
| NonDomStopsPerDomDC | TBD |
The number of non-domicile stops per domicile duty cycle. This includes the following API terms:
|
| PostStopTripDistance | Trip Distance After Stop |
Describes the trip distance after a stop has been made. This includes the following API terms:
|
| PostStopTripDuration | Trip Duration After Stop |
Describes the trip duration after a stop has been made. This includes the following API terms:
|
| PreStopTripDistance | Trip Distance Before Stop |
Describes the trip distance before a stop has been made. This includes the following API terms:
|
| PreStopTripDuration | Trip Duration Before Stop |
Describes the trip duration before a stop has been made. This includes the following API terms:
|
| StopCount | TBD | The number of stops in the zone. |
| StopDurationBins | TBD | Vehicle and stop counts by user-defined stop duration bins. |
| StopMetricsByDayOfWeek | N/A | Stop counts by day of week at the stop location. |
| StopMetricsByDirection | N/A | Stop counts by direction. Only available when analyzing by road segment. |
| StopMetricsByFuelType | N/A | Stop counts by fuel type. |
| StopMetricsByHour | N/A | Stop counts by hour of arrival at the stop location (local time). |
| StopMetricsByMonth | N/A | Stop counts by month at the stop location. |
| StoppedAtDomPct | TBD | The total percentage of activity during a particular time unit (hour, day of week or month) that can be attributed to a vehicle being stopped at their domicile. |
| StoppedAtNonDomPct | TBD | The total percentage of activity during a particular time unit (hour, day of week or month) that can be attributed to a vehicle being stopped at a non-domicile. |
| TotalDomVehicleCount | TBD | The number of vehicles that meet vehicle filters and have their domicile within the zone. |
| ZoneSubType | N/A |
The zone type sub classification
|
Traffic
| API term | UI term | Definition |
|---|---|---|
| DominantPace | Pace | The speed range (measured in mph or km/h) with the highest share of traffic. |
| DrivingPct | TBD | The total percentage of activity during a particular time unit (hour, day of week or month) that can be attributed to a vehicle driving. |
| FreeFlowSpeed | Free-flow Speed | Excluding any vehicle or time of day filters, the average 85th percentile spot speed for the latest month included in the analysis. |
| FreeFlowTravelTime | Free-flow Travel Time | The time it takes to pass the selected area when traveling at Free-flow speed. |
| IndexedAccelerationEvents | TBD | The count of acceleration harsh events along a road segment per 10,000 vehicle traversals. |
| IndexedBrakingEvents | TBD | The count of braking harsh events along a road segment per 10,000 vehicle traversals. |
| IndexedCorneringEvents | TBD | The count of cornering harsh events along a road segment per 10,000 vehicle traversals. |
| IndexedHarshEvents | TBD | The count of cornering harsh events along a road segment per 10,000 vehicle traversals. |
| ObservedAccelerationEvents | TBD | The count of acceleration based harsh events along a road segment for the given time. |
| ObservedBrakingEvents | TBD | The count of braking based harsh events along a road segment for the given time. |
| ObservedCorneringEvents | TBD | The count of cornering based harsh events along a road segment for the given time. |
| ObservedHarshEvents | TBD | The count of total harsh events along a road segment for the given time. |
| PctOfSpeedLimit | % of Speed Limit Travel Speed | The average Travel Speed as a percentage of the weighted average speed limit. |
| PctOverSpeedLimit | % of Trips Over the Speed Limit | The percentage of the vehicle passes where the Travel Speed or Spot Speed was over the speed limit. |
| PctFreeFlow SpotSpeed | % of Free-flow Spot Speed | Spot speed as a percentage of the Free-flow speed. |
| PercentOfFreeFlowTravelSpeed | % Free-flow Travel Speed | Travel speed as a percentage of Free-flow speed. |
| SpeedLimitAvg | Speed Limit | The average posted road speed, extracted from OSM. When not available, posted road speeds are estimated based on traffic speed, road type, and jurisdiction; using OSM speed limits as reference. |
| SpotSpeed | Spot Speed | The maximum individual speed observed as a vehicle drives through selected road segments. |
| SpotSpeedPctOfSpeedLimit | % of Speed Limit Spot Speed | The average Spot Speed as a percentage of the weighted average speed limit. |
| TravelTimeReliability | Travel Time Reliability Ratio | The ratio of free-flow to median travel time. Values closer to 1 indicate that the travel time of the slowest 15% of vehicles and the median are almost the same. A high value indicates that the slowest 15% of vehicles are much slower than the median. (i.e. reliability ratio of 2 implies that the slowest vehicles are 2x slower than the median). |
Regional Travel Metrics
| API term | UI term | Definition |
|---|---|---|
| AADT (Annual Average Daily Traffic) | N/A | Measurement used primarily in transportation and infrastructure planning, transportation engineering and retail location selection. Traditionally, it is the total volume of vehicle traffic of a highway or road for a year divided by 365 days. |
| AggregateAllZones | N/A | Either to sum results fuel economy over all zones (true) or report data fuel economy for each zone provided (false). The default is true. |
| FuelEconomy | N/A | Calculated fuel economy in miles, gallon (MPG) or liters, or 100 kms. |