Skip to main content
GET
Get optimization result

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

optimization_id
integer
required

Optimization identifier returned by POST /planner/v2.

Query Parameters

tenant_id
integer | null

Tenant ID

Response

Successful Response

Response body for GET /planner/optimizations/{optimization_id}/result.

optimization_id
integer
required

Optimization identifier.

tour_id
integer
required

Tour identifier.

status
enum<string>
required

Job lifecycle status; a result is available for succeeded or not_drivable.

Available options:
queued,
running,
succeeded,
not_drivable,
failed,
canceled
battery_level_start
number
required

Starting battery level (0-1).

battery_level_end
number
required

Battery level at the end of the tour (0-1).

qualification
string
required

Route feasibility result: Driveable or not_drivable. See status for job lifecycle.

sections
ResultSection · object[]
required

Route sections with charging stop details. May contain more sections than the request if charging stops were inserted.

poi_list
ResultPOI · object[]
required

Charging stations considered as candidates along the route.

poi_filter
POIInfo · object | null

Charging station filter criteria applied to this optimization.

optimal_departure_time
string | null

Optimal departure time (ISO-8601) for reaching all time windows, if applicable.

time_windows_reachable
string | null

Whether all time windows could be reached: 'True', 'False', or 'Not considered'.

available_charging_stations
ResultAvailableStation · object[] | null

All charging stations found within the route corridor, before the optimizer narrowed them down to the selected stops. Null for results created before this field was introduced.

not_drivable_reason
NotDrivableReason · object | null

Reason why the route is not drivable.

warnings
string[] | null

Advisory notes about this result that a dispatcher should check before dispatching — for example a custom search corridor, or a battery level that drops below the advisory minimum state of charge. Null when there is nothing to flag.