Trip search API with include overlapping trips finds an extra record

[joakimnordling]

Note: This might be either a problem in this python library or a problem in the Geotab API. I've not conducted deep enough investigation of the internals of this library or tested raw queries to the API to be sure which one it is. I do however suspect it might be a problem with the API and not just this library.

It looks like when you set the includeOverlappedTrips to True, and use a device search it for some reason also finds a trip that has an ID that matched the ID of the device, although the start and end time of that Trip is far outside the requested ones.

This has been tested against a demo database that I got created when I signed up to Geotab.

Let's examine this simple python script, using the library:

from datetime import datetime

import mygeotab


def main():
    client = mygeotab.API(
        username=...,
        password=...,
        database=...,
    )
    client.authenticate()

    trips = client.get(
        "Trip",
        search={
            "deviceSearch": {"id": "b1"},
            "fromDate": datetime.fromisoformat("2025-07-21T00:00:00Z"),
            "toDate": datetime.fromisoformat("2025-07-21T00:35:00Z"),
            "includeOverlappedTrips": True,
        },
    )
    for t in trips:
        print(
            f"Trip ID: {t['id']}, start: {t['start'].isoformat()}, stop: {t['stop'].isoformat()}, nextTripStart: {t['nextTripStart'].isoformat()}"
        )


if __name__ == "__main__":
    main()

With includeOverlappedTrips set to True it prints this:

Trip ID: b1, start: 2025-07-17T22:06:04.492000+00:00, stop: 2025-07-17T23:06:04.492000+00:00, nextTripStart: 2025-08-19T13:08:40.328000+00:00
Trip ID: bD8, start: 2025-07-20T23:55:02+00:00, stop: 2025-07-21T00:03:21+00:00, nextTripStart: 2025-07-21T00:03:22+00:00
Trip ID: bD9, start: 2025-07-21T00:03:22+00:00, stop: 2025-07-21T00:20:36+00:00, nextTripStart: 2025-07-21T00:31:39+00:00
Trip ID: bDA, start: 2025-07-21T00:31:39+00:00, stop: 2025-07-21T00:54:03+00:00, nextTripStart: 2025-07-21T01:04:32+00:00

As you can see it for some reason believes the trip with id b1 (first row) should be included in the returned data, although the start/stop/nextTripStart date are all less than the fromDate I've specified. It looks like the id from the deviceSearch somehow ends up as an extra ID for a trip to include in the response.

Actually, if I change the id in the deviceSearch to b2, b3 or b4 I instead get a trip with that ID as the first one in the response:

# b2
Trip ID: b2, start: 2025-07-17T22:06:04.492000+00:00, stop: 2025-07-17T23:06:04.492000+00:00, nextTripStart: 2025-08-19T13:12:05.910000+00:00
Trip ID: b43A, start: 2025-07-20T23:36:28+00:00, stop: 2025-07-21T00:01:50+00:00, nextTripStart: 2025-07-21T00:12:00+00:00
Trip ID: b43B, start: 2025-07-21T00:12:00+00:00, stop: 2025-07-21T00:20:19+00:00, nextTripStart: 2025-07-21T00:20:20+00:00
Trip ID: b43C, start: 2025-07-21T00:20:20+00:00, stop: 2025-07-21T00:37:34+00:00, nextTripStart: 2025-07-21T00:48:37+00:00
# b3
Trip ID: b3, start: 2025-07-17T22:06:04.492000+00:00, stop: 2025-07-17T23:06:04.492000+00:00, nextTripStart: 2025-08-19T13:15:02.719000+00:00
Trip ID: b14E6, start: 2025-07-20T23:53:26+00:00, stop: 2025-07-21T00:18:48+00:00, nextTripStart: 2025-07-21T00:28:58+00:00
Trip ID: b14E7, start: 2025-07-21T00:28:58+00:00, stop: 2025-07-21T00:37:17+00:00, nextTripStart: 2025-07-21T00:37:18+00:00
# b4
Trip ID: b4, start: 2025-07-17T22:06:04.492000+00:00, stop: 2025-07-17T23:06:04.492000+00:00, nextTripStart: 2025-08-19T13:15:25.334000+00:00
Trip ID: b10B8, start: 2025-07-20T23:43:47+00:00, stop: 2025-07-21T00:04:06+00:00, nextTripStart: 2025-07-21T00:10:24+00:00
Trip ID: b10B9, start: 2025-07-21T00:10:24+00:00, stop: 2025-07-21T00:35:46+00:00, nextTripStart: 2025-07-21T00:45:56+00:00

If I change the includeOverlappedTrips to False, then there is no Trip with an ID matching the ID of the requested device. So the problem seems to occur only when the includeOverlappedTrips is enabled.

It is of course easy to filter out the extra item in our own code, but a bit sad the client is returning stuff that needs extra filtering out of unwanted data.

If anyone from Geotab side wants to check the database it's my demo databse demo_jockes_longdistance_passenger that has been used and it was generated automatically when I signed up. I think it will be deleted automatically by your system in something like 60 days minus 1-2 weeks from now.

[joakimnordling]

Update: I decided to dig a bit deeper. It looks to me like it's a problem with the API actually and not this python library. So if the maintainers of this repo could be kind and report it to the right place, I'd be grateful.

I managed to construct this curl command to fetch the data directly from the API:

curl --request POST \
  --url https://my.geotab.com/apiv1 \
  --header 'Content-Type: application/json' \
  --data '{
	"method":"Get",
	"params":{
		"search":{
			"deviceSearch":{
				"id":"b1"
			},
			"fromDate":"2025-07-21T00:00:00.000Z",
			"toDate":"2025-07-21T00:35:00.000Z",
			"includeOverlappedTrips":true
		},
		"typeName":"Trip",
		"credentials":{
			"userName":"...",
			"sessionId":"...",
			"database":"demo_jockes_longdistance_passenger"
		}
	}
}'

And the raw response from the API also includes the Trip with the id b1:

{
  "result": [
    {
      "afterHoursDistance": 0,
      "afterHoursDrivingDuration": "00:55:00",
      "afterHoursEnd": false,
      "afterHoursStart": false,
      "afterHoursStopDuration": "00:00:00",
      "averageSpeed": 0,
      "distance": 0,
      "drivingDuration": "01:00:00",
      "engineHours": 6073490,
      "idlingDuration": "00:00:00",
      "maximumSpeed": 100,
      "nextTripStart": "2025-08-19T13:42:40.873Z",
      "speedRange1": 10,
      "speedRange1Duration": "00:05:00",
      "speedRange2": 0,
      "speedRange2Duration": "00:05:00",
      "speedRange3": 0,
      "speedRange3Duration": "00:05:00",
      "start": "2025-07-17T22:06:04.492Z",
      "stop": "2025-07-17T23:06:04.492Z",
      "stopDuration": "00:00:00",
      "stopPoint": {
        "x": 6.043392181396484,
        "y": 50.78428268432617
      },
      "workDistance": 0,
      "workDrivingDuration": "00:05:00",
      "workStopDuration": "00:00:00",
      "device": {
        "id": "b1"
      },
      "driver": "UnknownDriverId",
      "version": "0000000000000001",
      "id": "b1"
    },
    {
      "afterHoursDistance": 8.659476,
      "afterHoursDrivingDuration": "00:08:19",
      "afterHoursEnd": true,
      "afterHoursStart": true,
      "afterHoursStopDuration": "00:00:01",
      "averageSpeed": 62.473175,
      "distance": 8.659476,
      "drivingDuration": "00:08:19",
      "engineHours": 6254576,
      "idlingDuration": "00:00:00",
      "isSeatBeltOff": false,
      "maximumSpeed": 114,
      "nextTripStart": "2025-07-21T00:03:22.000Z",
      "speedRange1": 0,
      "speedRange1Duration": "00:00:00",
      "speedRange2": 0,
      "speedRange2Duration": "00:00:00",
      "speedRange3": 0,
      "speedRange3Duration": "00:00:00",
      "start": "2025-07-20T23:55:02.000Z",
      "stop": "2025-07-21T00:03:21.000Z",
      "stopDuration": "00:00:01",
      "stopPoint": {
        "x": 6.043392181396484,
        "y": 50.78428268432617
      },
      "workDistance": 0,
      "workDrivingDuration": "00:00:00",
      "workStopDuration": "00:00:00",
      "device": {
        "id": "b1"
      },
      "driver": "UnknownDriverId",
      "version": "00000000000000d8",
      "id": "bD8"
    },
    {
      "afterHoursDistance": 21.055967,
      "afterHoursDrivingDuration": "00:17:14",
      "afterHoursEnd": true,
      "afterHoursStart": true,
      "afterHoursStopDuration": "00:11:03",
      "averageSpeed": 73.308975,
      "distance": 21.055967,
      "drivingDuration": "00:17:14",
      "engineHours": 6255610,
      "idlingDuration": "00:00:00",
      "isSeatBeltOff": false,
      "maximumSpeed": 140,
      "nextTripStart": "2025-07-21T00:31:39.000Z",
      "speedRange1": 4,
      "speedRange1Duration": "00:02:31.3420000",
      "speedRange2": 1,
      "speedRange2Duration": "00:00:42",
      "speedRange3": 0,
      "speedRange3Duration": "00:00:00",
      "start": "2025-07-21T00:03:22.000Z",
      "stop": "2025-07-21T00:20:36.000Z",
      "stopDuration": "00:11:03",
      "stopPoint": {
        "x": 6.303206443786621,
        "y": 50.821990966796875
      },
      "workDistance": 0,
      "workDrivingDuration": "00:00:00",
      "workStopDuration": "00:00:00",
      "device": {
        "id": "b1"
      },
      "driver": "UnknownDriverId",
      "version": "00000000000000d9",
      "id": "bD9"
    },
    {
      "afterHoursDistance": 21.886353,
      "afterHoursDrivingDuration": "00:22:24",
      "afterHoursEnd": true,
      "afterHoursStart": true,
      "afterHoursStopDuration": "00:10:29",
      "averageSpeed": 58.624157,
      "distance": 21.886353,
      "drivingDuration": "00:22:24",
      "engineHours": 6256954,
      "idlingDuration": "00:00:00",
      "isSeatBeltOff": false,
      "maximumSpeed": 146,
      "nextTripStart": "2025-07-21T01:04:32.000Z",
      "speedRange1": 3,
      "speedRange1Duration": "00:01:38.7400000",
      "speedRange2": 3,
      "speedRange2Duration": "00:01:40.6520000",
      "speedRange3": 1,
      "speedRange3Duration": "00:00:03.8330000",
      "start": "2025-07-21T00:31:39.000Z",
      "stop": "2025-07-21T00:54:03.000Z",
      "stopDuration": "00:10:29",
      "stopPoint": {
        "x": 6.511667251586914,
        "y": 50.7786750793457
      },
      "workDistance": 0,
      "workDrivingDuration": "00:00:00",
      "workStopDuration": "00:00:00",
      "device": {
        "id": "b1"
      },
      "driver": "UnknownDriverId",
      "version": "00000000000000da",
      "id": "bDA"
    }
  ],
  "jsonrpc": "2.0"
}

[aaront]

Hi Joakim, You can report it directly at the developers hub: https://community.geotab.com/s/developers-hub?language=en_US Someone will help you out there! Aug 19, 2025 09:48:57 Joakim Nordling ***@***.***>:

…

[Image]*joakimnordling* left a comment (Geotab/mygeotab-python#130)[#130 (comment)] Update: I decided to dig a bit deeper. It looks to me like it's a problem with the API actually and not this python library. So if the maintainers of this repo could be kind and report it to the right place, I'd be grateful. I managed to construct this curl command to fetch the data directly from the API: curl --request POST \ --url https://my.geotab.com/apiv1 \ --header 'Content-Type: application/json' \ --data '{ "method":"Get", "params":{ "search":{ "deviceSearch":{ "id":"b1" }, "fromDate":"2025-07-21T00:00:00.000Z", "toDate":"2025-07-21T00:35:00.000Z", "includeOverlappedTrips":true }, "typeName":"Trip", "credentials":{ "userName":"...", "sessionId":"...", "database":"demo_jockes_longdistance_passenger" } } }' And the raw response from the API also includes the Trip with the id *b1*: { "result": [ { "afterHoursDistance": 0, "afterHoursDrivingDuration": "00:55:00", "afterHoursEnd": false, "afterHoursStart": false, "afterHoursStopDuration": "00:00:00", "averageSpeed": 0, "distance": 0, "drivingDuration": "01:00:00", "engineHours": 6073490, "idlingDuration": "00:00:00", "maximumSpeed": 100, "nextTripStart": "2025-08-19T13:42:40.873Z", "speedRange1": 10, "speedRange1Duration": "00:05:00", "speedRange2": 0, "speedRange2Duration": "00:05:00", "speedRange3": 0, "speedRange3Duration": "00:05:00", "start": "2025-07-17T22:06:04.492Z", "stop": "2025-07-17T23:06:04.492Z", "stopDuration": "00:00:00", "stopPoint": { "x": 6.043392181396484, "y": 50.78428268432617 }, "workDistance": 0, "workDrivingDuration": "00:05:00", "workStopDuration": "00:00:00", "device": { "id": "b1" }, "driver": "UnknownDriverId", "version": "0000000000000001", "id": "b1" }, { "afterHoursDistance": 8.659476, "afterHoursDrivingDuration": "00:08:19", "afterHoursEnd": true, "afterHoursStart": true, "afterHoursStopDuration": "00:00:01", "averageSpeed": 62.473175, "distance": 8.659476, "drivingDuration": "00:08:19", "engineHours": 6254576, "idlingDuration": "00:00:00", "isSeatBeltOff": false, "maximumSpeed": 114, "nextTripStart": "2025-07-21T00:03:22.000Z", "speedRange1": 0, "speedRange1Duration": "00:00:00", "speedRange2": 0, "speedRange2Duration": "00:00:00", "speedRange3": 0, "speedRange3Duration": "00:00:00", "start": "2025-07-20T23:55:02.000Z", "stop": "2025-07-21T00:03:21.000Z", "stopDuration": "00:00:01", "stopPoint": { "x": 6.043392181396484, "y": 50.78428268432617 }, "workDistance": 0, "workDrivingDuration": "00:00:00", "workStopDuration": "00:00:00", "device": { "id": "b1" }, "driver": "UnknownDriverId", "version": "00000000000000d8", "id": "bD8" }, { "afterHoursDistance": 21.055967, "afterHoursDrivingDuration": "00:17:14", "afterHoursEnd": true, "afterHoursStart": true, "afterHoursStopDuration": "00:11:03", "averageSpeed": 73.308975, "distance": 21.055967, "drivingDuration": "00:17:14", "engineHours": 6255610, "idlingDuration": "00:00:00", "isSeatBeltOff": false, "maximumSpeed": 140, "nextTripStart": "2025-07-21T00:31:39.000Z", "speedRange1": 4, "speedRange1Duration": "00:02:31.3420000", "speedRange2": 1, "speedRange2Duration": "00:00:42", "speedRange3": 0, "speedRange3Duration": "00:00:00", "start": "2025-07-21T00:03:22.000Z", "stop": "2025-07-21T00:20:36.000Z", "stopDuration": "00:11:03", "stopPoint": { "x": 6.303206443786621, "y": 50.821990966796875 }, "workDistance": 0, "workDrivingDuration": "00:00:00", "workStopDuration": "00:00:00", "device": { "id": "b1" }, "driver": "UnknownDriverId", "version": "00000000000000d9", "id": "bD9" }, { "afterHoursDistance": 21.886353, "afterHoursDrivingDuration": "00:22:24", "afterHoursEnd": true, "afterHoursStart": true, "afterHoursStopDuration": "00:10:29", "averageSpeed": 58.624157, "distance": 21.886353, "drivingDuration": "00:22:24", "engineHours": 6256954, "idlingDuration": "00:00:00", "isSeatBeltOff": false, "maximumSpeed": 146, "nextTripStart": "2025-07-21T01:04:32.000Z", "speedRange1": 3, "speedRange1Duration": "00:01:38.7400000", "speedRange2": 3, "speedRange2Duration": "00:01:40.6520000", "speedRange3": 1, "speedRange3Duration": "00:00:03.8330000", "start": "2025-07-21T00:31:39.000Z", "stop": "2025-07-21T00:54:03.000Z", "stopDuration": "00:10:29", "stopPoint": { "x": 6.511667251586914, "y": 50.7786750793457 }, "workDistance": 0, "workDrivingDuration": "00:00:00", "workStopDuration": "00:00:00", "device": { "id": "b1" }, "driver": "UnknownDriverId", "version": "00000000000000da", "id": "bDA" } ], "jsonrpc": "2.0" } — Reply to this email directly, view it on GitHub[#130 (comment)], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AAAMHLFBXHMZE7CYFZMHRAT3OMTMTAVCNFSM6AAAAACEIJ7FU6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTEMBQHA2DQMRWGA]. You are receiving this because you are subscribed to this thread.

[joakimnordling]

Thanks @aaront, posted it there, can be found at https://community.geotab.com/s/question/0D5Pd00000lY81jKAC/trip-search-api-with-include-overlapping-trips-finds-an-extra-record, likely only after passing some review.