Get drivers

get

https://v3.api.hypertrack.com/drivers/

Fetch drivers in a paginated list

Query Params

ops_group_handle

string | null

Defaults to null

List of ops group handles as comma separated strings used for fetching associated Drivers

search_term

string | null

Defaults to null

Keyword to match against driver handle, name OR profile

profile

string | null

Defaults to null

Profile filter to be applied on the list of drivers

pagination_token

string | null

Defaults to null

Identifier used to fetch the next page of data

driver_handle

string | null

Defaults to null

List of driver handles as comma separated strings used for fetching associated Drivers

device_id

uuid | null

Defaults to null

Unique identifier for a driver's device. This field is present in case the driver is currently linked with a device

include_deleted

boolean

Defaults to false

Flag to include deleted drivers

from_time

date-time | null

Defaults to null

ISO 8601 datetime indicating the start time to be used for computing summary, status.

to_time

date-time | null

Defaults to null

ISO 8601 datetime indicating the end time to be used for computing summary, status.

from_date

string | null

Defaults to null

ISO 8601 date format ('yyyy-MM-dd') indicating the start date to be used for the summary computation.

to_date

string | null

Defaults to null

ISO 8601 date format ('yyyy-MM-dd') indicating the end date to be used for the summary computation.

limit

integer | null

Defaults to 25

Number of Drivers to be sent in response

include_schedule

boolean

Defaults to true

Flag to include driver's schedule in the response.

include_summary

boolean

Defaults to true

Flag to include driver's summary stats in the response.

filter_outage

string | null

Defaults to null

Filter drivers on a particular outage code.

filter_outage_category

string | null

Defaults to null

List of comma separated outage categories to be used for filtering drivers. Valid categories: behavioural,adversarial,reachability,os,sporadic

filter_geofence_metadata

string | null

Defaults to null

geofence_metadata filter for aggregate response

aggregate

boolean

Defaults to false

Flag set to retrieve aggregated data over the provided time range

work_status

string | null

Defaults to null

URL-encoded json string specifying filters on availability or tracking.

filter_status

string | null

enum

Defaults to null

Parameter to filter on driver status

Allowed:

tracked

boolean | null

Defaults to null

If set to true, only shows drivers that were actually tracked between from_time to to_time.

worked

boolean | null

Defaults to null

If set to true, only shows drivers that actually worked between from_time to to_time.

intended_to_track

boolean | null

Defaults to null

If set to true, only shows drivers that was supposed to be tracked between from_time to to_time.

Responses

200Successful response

401Authentication error

422Validation error