Documentation Index
Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt
Use this file to discover all available pages before exploring further.
This minor release introduces the new Telematics Analytics API, standardizes response formats across all endpoints with improved pagination and sorting.
Note: This release includes page size reductions for improved performance.
Endpoint Changes
Analytics API (New)
Analytics API (New)
Added:
GET /v2/telematics/analytics/drivers- Retrieve driver profiles with compliance metrics including safety events and HOS violations in the last 30 days.GET /v2/telematics/analytics/drivers/time-series- Retrieve daily and cumulative driver counts over a specified period for workforce growth charts.GET /v2/telematics/analytics/fleets- Retrieve aggregated metrics for each fleet including vehicle counts, driver counts, and connection health.GET /v2/telematics/analytics/fleets/time-series- Retrieve daily and cumulative fleet counts over a specified period for growth charts.GET /v2/telematics/analytics/overview- Retrieve a high-level summary of fleet, vehicle, driver, and trailer counts for your organization.GET /v2/telematics/analytics/trailers- Retrieve trailer profiles with identification details and latest location data for asset tracking.GET /v2/telematics/analytics/trailers/live-locations- Retrieve real-time trailer locations and associated vehicle/driver information for live asset tracking.GET /v2/telematics/analytics/trailers/time-series- Retrieve daily and cumulative trailer counts over a specified period for asset growth charts.GET /v2/telematics/analytics/vehicles- Retrieve vehicle profiles with static attributes and latest telemetry snapshot for asset inventories.GET /v2/telematics/analytics/vehicles/live-locations- Retrieve real-time vehicle locations and telemetry (speed, fuel, engine hours) for live fleet maps or dispatch boards.GET /v2/telematics/analytics/vehicles/time-series- Retrieve daily and cumulative vehicle counts over a specified period for growth charts.
New Query Parameters
Specific endpoints have received new filtering and sorting capabilities.HOS Events
HOS Events
GET /v2/telematics/hos-eventsactive_from_datetime: Filter for events active starting from this timestampactive_to_datetime: Filter for events active up to this timestampevent_type_codes: Filter by specific HOS event types
Trailer Locations
Trailer Locations
GET /v2/telematics/trailer-locationsvehicle_ids: Filter locations by associated vehicle IDs
Users
Users
GET /v2/telematics/usersis_driver: Boolean filter to specifically include or exclude drivers
Sorting & Ordering
Sorting & Ordering
The following endpoints now support
sort_by and sort_order parameters:GET /v2/telematics/driver-safety-eventsGET /v2/telematics/dvir-defectsGET /v2/telematics/dvir-logsGET /v2/telematics/hos-availabilitiesGET /v2/telematics/hos-daily-snapshotsGET /v2/telematics/hos-violationsGET /v2/telematics/ifta-summariesGET /v2/telematics/trailersGET /v2/telematics/vehicle-sensor-eventsGET /v2/telematics/vehiclesGET /v2/telematics/users
Limit Adjustments
HOS Events Limits
- Page Size Reduction: The maximum
sizeparameter forGET /v2/telematics/hos-eventshas been reduced from 1000 to 500 to improve performance with large event objects.
New Features
Pagination Totals
Pagination Totals
Paginated responses now include a
total field indicating the total count of records.Fleet References
Fleet References
All major resources now include a
fleet_ref field, providing the external fleet identifier alongside the internal fleet_id.Migration Checklist
Check HOS Page Sizes
Ensure your integration does not request more than 500 items per page for HOS endpoints.
Need Help?
API Reference
View complete endpoint documentation with current API structure
Contact Support
Questions about migrating your integration? Our team is here to help