Returns all trips specified by query terms.

SecurityAPIKey
Request
Request Body schema: application/json
startTime
string <date-time>

Trips that began after this date (inclusive).

endTime
string <date-time>

Trips that began before this date (inclusive).

groupId
string or null <guid>
Deprecated

Group Id (and its subgroups) associated to a trip's vehicle.

groupIds
Array of strings or null <guid>

Group Ids (not including subgroups) associated to a trip's vehicle.

driverId
string or null <guid>

Driver Id associated to trip.

vehicleId
string or null <guid>

Vehicle Id associated to trip.

sortColumn
string or null

Column used to sort trips. Possible values: ScheduleEnd (default), ScheduleStart, VehicleName, DriverName, EmployeeId, or DriverIdentificationType

sortDirection
string or null

Sort direction of the sort column. Possible values: asc (default) or desc.

pageNumber
integer <int32> [ 1 .. 2147483647 ]

The page number of the list of trips. Default value is 1.

pageSize
integer <int32> [ 1 .. 2147483647 ]

The number of trips to return per page. Default value is 1000.

Responses
200
400

The parameters given in the request are invalid.

401

The request could not be authenticated. It can occur due to inputting an invalid key or invalid pod.

403

Access is denied to query trips for the specified group id. The given API key's context does not have the proper permissions.

500
post/trips
Request samples
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "groupIds": [
    ],
  • "driverId": "string",
  • "vehicleId": "string",
  • "sortColumn": "string",
  • "sortDirection": "string",
  • "pageNumber": 1,
  • "pageSize": 1000
}
Response samples
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}
© 2023 Lytx, Inc. All rights reserved