​
v1.4.0 (Alpha Release) - October 10, 2024

We’re excited to announce the latest update to the MileIQ External API! This release brings significant enhancements to our data models and introduces new fields for more comprehensive drive information.

​
Added

  • Currency Enum: Introduced a new Currency enum with values USD, CAD, and GBP.
  • DriveClassification Enum: Added a DriveClassification enum with values business, personal, and unclassified.
  • DriveEntry Enum: Created a DriveEntry enum with values manual and automatic.
  • Purpose Field: Added a new purpose field to the DriveDetails model to capture the purpose of the drive as provided by the driver.
  • Drive Notes: Added support for retrieving optional notes on drives, allowing consumers to access additional context or information for each trip provided by the driver.
  • Toll Fees: Introduced a new toll_fees field in the DriveDetails model, enabling access to toll expense information for each drive.
  • Review Comments: Implemented a new ReviewComment model and added review_comments to the DriveResponse. This feature provides visibility into the review process and any associated comments.

​
Changed

  • DriveDetails Model:

    • Updated classification to use the new DriveClassification enum.
    • Changed entry to use the new DriveEntry enum.

  • Value Model: Updated currency to use the new Currency enum.

  • Geolocation Model: Added descriptions to all fields for better clarity.

  • ReviewComment Model: Added descriptions to all fields for improved documentation.

​
Improved

  • Added detailed descriptions to many fields across various models, enhancing the API documentation.
  • Updated example responses to reflect the new structure and additional fields.

​
Key Features

  • Access drive notes for better context and understanding of reported trips.
  • Retrieve toll fee information separately from the overall drive value.
  • View review comments associated with drives, providing insights into the review process performed by the admin.
  • More structured information about drives, including their classification, entry method, and purpose.

​
Notes

This alpha release continues to refine our API structure and data models. We’ve focused on providing more detailed and structured information about drives, allowing for more precise reporting and analysis of drive data. These enhancements build on our commitment to providing comprehensive read-only access to reported drive data for reimbursement and analysis purposes.

We appreciate your ongoing feedback as we continue to improve our API. Please report any issues or suggestions through your customer success manager.

​
v1.0.0 (Alpha Release) - September 18, 2024

We’re excited to announce the first alpha release of the MileIQ External API! This release provides core functionality for read-only access to drive data from the MileIQ Platform.

​
Added

  • Authentication: Implemented API Key authentication using the Authorization header.

  • Drives Endpoint:

    • /v1/drives: Get an ordered list of reported drives with filtering options.

  • Core Data Models:

    • DriveResponse: Represents a single reported drive (trip) with drive and driver details.
    • Driver: Contains essential driver information.
    • DriveDetails: Includes distance, value, classification, and location data for a drive.

  • Geolocation Support: Added ability to retrieve start and end location data for drives.

  • Error Handling: Implemented validation error responses for better debugging.

​
Key Features

  • Retrieve reported drive data with options to filter by modification date.
  • Access detailed information about individual reported drives.
  • Support for both business and personal drive classifications.
  • Comprehensive drive details including distance, monetary value, and locations.

​
Notes

This is an alpha release, and we welcome your feedback as we continue to improve and expand the API. Please report any issues or suggestions through your customer success manager.

We’re committed to keeping you informed about changes and improvements to the MileIQ External API. Stay tuned for future updates!

Rate LimitingExample: Retrieving Drives