> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/fleet/driver_journal/proposal.md).

# Trip proposals

The raw trips over a period that a driver journal entry can be created from.

A proposal is a trip the Navixy platform detected over a period that has not yet been categorised. Proposals are the raw material for the [driver journal](/docs/navixy-api/user-api/resources/fleet/driver_journal/entry.md): read them for a period, decide what each trip was, and create entries from them.

For a walkthrough, see [how to use driver journals](/docs/navixy-api/user-api/guides/fleet-management/driver-journals.md).

## API actions

API base path: `/driver/journal/proposal`.

Proposal objects are created by dividing a track at each driver change. If there was no driver change on the track, then the track is returned entirely. Tracks are selected by intersecting their date range with the date range in the request.

This call needs the `driver_journal` feature on the tracker's plan.

***

## List trip proposals

> Return the trips over a period that could be turned into driver journal entries.\
> \
> A proposal is a track split at each driver change. A track with no driver change is returned whole. Tracks are selected by intersecting their date range with the requested period.\
> \
> Use \`overlapped\` to tell which proposals would collide with an entry that already exists.\
> \
> Needs the \`driver\_journal\` feature on the tracker's plan, and returns error 236 without it.\
> \
> A request with an empty body reports \`interval\` as the missing parameter. That is the internal name of the field holding both dates; the public parameters are \`from\` and \`to\`.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Driver journal","description":"Trips categorised as work, personal or other, and the proposals a track can be turned into. All resources under the /driver/journal/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"JournalLocation":{"type":"object","description":"A point with an address. Unlike a depot location it carries no radius.","properties":{"lat":{"type":"number","description":"Latitude."},"lng":{"type":"number","description":"Longitude."},"address":{"type":"string","description":"Address at this point."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/driver/journal/proposal/list":{"post":{"tags":["Driver journal"],"summary":"List trip proposals","description":"Return the trips over a period that could be turned into driver journal entries.\n\nA proposal is a track split at each driver change. A track with no driver change is returned whole. Tracks are selected by intersecting their date range with the requested period.\n\nUse `overlapped` to tell which proposals would collide with an entry that already exists.\n\nNeeds the `driver_journal` feature on the tracker's plan, and returns error 236 without it.\n\nA request with an empty body reports `interval` as the missing parameter. That is the internal name of the field holding both dates; the public parameters are `from` and `to`.","operationId":"driverJournalProposalList","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.","minimum":1},"from":{"type":"string","description":"Include tracks which end after this date."},"to":{"type":"string","description":"Include tracks which start before this date."}},"required":["tracker_id","from","to"]}}}},"responses":{"200":{"description":"Trips that could become entries","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"type":"object","description":"A trip that could be turned into a driver journal entry.","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as `object_id`."},"employee_id":{"type":["integer","null"],"description":"ID of the employee driving, or null when nobody was identified."},"start_date":{"type":"string","description":"Start date and time of the trip."},"end_date":{"type":"string","description":"End date and time of the trip."},"start_location":{"allOf":[{"$ref":"#/components/schemas/JournalLocation"}],"description":"Where the trip starts."},"end_location":{"allOf":[{"$ref":"#/components/schemas/JournalLocation"}],"description":"Where the trip ends."},"length":{"type":"number","description":"Length of the trip, in kilometres."},"start_odometer":{"type":["number","null"],"description":"Odometer value at the start."},"end_odometer":{"type":["number","null"],"description":"Odometer value at the end."},"overlapped":{"type":"boolean","description":"`true` when a driver journal entry already exists whose date range intersects this proposal."}}}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the tracker's plan does not include the driver journal feature.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 236 - The tracker's plan does not include the driver journal feature.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/fleet/driver_journal/proposal.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.