Introduction to Altitude API

Explore how Altitude by Geotab leverages its API to provide actionable insights and enhance roadway analysis by integrating with various data sources.

Altitude by Geotab is designed to help users intuitively understand their roadways. The Altitude platform data layer is serviced in its entirety by the Altitude API, so the same data that drives the Altitude user interface (UI) is available in its basic form through direct requests to the API. This allows our Customers to glean actionable information by combining these insights with other disparate data sources to work towards alleviating inefficient and congested roadways.

The Altitude API suite complements the Altitude platform in its function. The end-user version of Altitude provides a point-and-click experience to deliver insights and support visualizations. You may need to extend your analysis beyond the insights and visualizations presented in the UI for specific use cases, processing needs, or to merge or overlay data with other existing data sets. The Altitude API allow you to get compatible data to support these use cases.

This guide outlines the API requests related to the various applications of the Altitude platform. It describes the business rules for accessing the API and its associated data.

Important:

If you are new to using Altitude APIs, refer to the Quick Reference Guide to learn how to set up a Python notebook environment, reference the Altitude API Guide to locate specific queries, and run API calls in the Python notebook.

Our Data

Altitude data is 100% observed, not modeled, comprised of aggregated Geotab assets’ commercial data, and based on actual movement observed.

Note:

The aggregated data is generated based on defined criteria and filtered to respect all relevant privacy legislation and internal standards.

Data Quality

Increase your level of confidence in your analysis results by combining Geotab data with:
  • Expansion Factors
  • Alternative third-party data sources
The following may impact how your data is interpreted:
  • OSM (OpenStreetMap) updates
  • Data recency
  • Overlapping zones and trip behavior
  • Data that has not passed our privacy restrictions

API Module Overview

The Altitude API is provisioned through a modular architecture consisting of six service modules. Each module is dedicated to a distinct functional area, offering a suite of APIs tailored to a primary function, from general data services to specialized Origin and Destination analysis and regional travel metrics.

Note:

The General and Zones modules are available to all Altitude users, while Origin and Destination, Stop Analytics, Traffic Analytics, and Regional Travel Metrics are subject to licensing.

ApplicationAPI Service ModuleDescription
Generaldna-altitude-generalServices common data sets that are utilized across the platform.
Origin and Destinationdna-altitude-odWith the ability to create full journeys by chaining trips together over multiple duty cycles, understand true origins and destinations to better manage the movement of goods. Uncover the context behind journeys with detailed insights into commercial vehicle movements, reporting on vocation, class and industry.
Stop Analyticsdna-altitude-stop-analytics Gain insights into heavy-truck parking patterns to inform freight parking plans. This module provides a comprehensive understanding of where and why vehicles are stopping, enabling stronger planning.
Traffic Analyticsdna-altitude-traffic Understand traffic patterns per road segment, including interstate highways, major arterials, connectors and more. The Traffic Analytics module offers critical traffic-related information for safer road design and efficient freight movement, helping transportation planners optimize routes and achieve compliance.
Regional Travel Metricsdna-altitude-rtm Gain insights into basic vehicle characteristics and the observed vehicle distances traveled within a specific geography. This module provides essential metrics for regional travel analysis, such as AADT (Annual Average Daily Traffic), aiding in comprehensive regional planning and infrastructure management.
Zonesdna-altitude-zonesSupports administrative activities for custom zones, such as creating, updating, and reading zone types and custom zones. Also supports the retrieval of Altitude zone definitions, including geography. These APIs support the zone management module and various zone based insights across the platform.