Navigation

Arguments

id· ID· required
ID of the navigation session to retrieve

Fields

id· ID
ID of the navigation session.
overview· NavigationOverview
Navigation session details overview.
vehicle_status· NavigationVehicleStatus
The status of the navigation session vehicle. The status can be driving, charging or parked.
driving

Vehicle is driving.

charging

Vehicle is charging.

parked

Vehicle is parked.

status· NavigationStatus
The status of a navigation session. The status can be active, finished or error.
active

Navigation session is live and currently tracking.

finished

Navigation session is completed (either manually or automatically 48 hours after the last update).

error

Failed to update navigation session due to route error or not found.

meta· NavigationMeta
Navigation meta information.

Exceptions

Codes

navigation_invalid_route_status
Cannot start a navigation session for a route with status '$ROUTESTATUS'.
navigation_not_found
No navigation session was found with the provided ID.
operation_not_allowed
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
rate_limit_exceeded
Rate limit exceeded.
route_polyline_invalid_decimals
Value for decimals number is not valid. Allowed values are 5 or 6.
  • Getting started

    Get started with the Chargetrip API.

  • API reference

    Browse our api and endpoints.

  • Examples

    Explore examples and start building.

How filter works

The filter argument lets you narrow down results by passing an input object with specific criteria. Each field within the filter is optional — only include the ones relevant to your query.