HYhypertrack
Visits

Get Visit by id

Retrieve Visit associated with visit_id. This API provides the ability to fetch visit based on visit_id

get/visits/{visit_id}

Request

Path parameters

visit_idstring required

Response

Successful response

visit_idstring uuid required

Unique identifier representing each visit.

created_atstring required

Creation timestamp of visit

updated_atstring nullable

Last Updated timestamp of visit

geofence_idstring uuid required

GeofenceId associated with visit

driver_handlestring

Driver handle for this visit

worker_handlestring

Worker handle for this visit

worker_namestring nullable

Worker name for this visit

worker_profileobject nullable

Worker profile associated with visit.

device_idstring uuid nullable

Device id associated with visit

order_handlestring required

Order handle for this visit

place_handlestring nullable

Place handle for this visit

ops_group_handlestring required

Ops Group handle for this visit

metadataobject nullable

Metadata associated with this visit.

geofence_metadataobject nullable

Geofence Metadata associated with the visit.

tracking_ratenumber

Driver tracking rate during the lifespan of the order

system_generated_order_handleboolean nullable

Boolean to filter out orders where order handle was automatically generated by HT system

geofence_addressstring nullable

Geofence address for this visit

timezonestring nullable

Timezone associated with this visit

Changes

No recorded changes to this operation across all 1 revision of this API.