Visits

Get Visits

Retrieves Visits associated with orders. This API provides the ability to filter for visits based on a set of query parameters.

get/visits/

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/visits/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

visit_idstring uuid nullable

Unique identifier representing each visit.

geofence_idstring uuid nullable

Geofence Id associated with visit

driver_handlestring nullable

String representing the handle for the driver to fetch the required visits.

worker_handlestring nullable

String representing the handle for the worker to fetch the required visits.

device_idstring uuid nullable

Device Id associated with visit

order_handlestring nullable

String representing the handle for the order to fetch the required visits.

place_handlestring nullable

String representing the handle for the place to fetch the required visits.

pagination_tokenstring nullable

Identifier used to fetch the next page of data

visited_at_fromstring date-time nullable

ISO 8601 datetime indicating the visit's start time for filtering

visited_at_tostring date-time nullable

ISO 8601 datetime indicating the visit's end time for filtering

metadata_filterstring Encoded JSON nullable

JSON encoded string metadata associated with the visits

region_filterstring Encoded JSON nullable

JSON encoded string region associated with the visits

search_termstring nullable

String representing the search term. Search will be done on order_handle, ops_group_handle, driver_handle and metadata fields.

aggregateboolean

Flag set to retrieve aggregated data over the provided time range

arrived_at_date_without_tz_fromstring nullable

Start date (YYYY-MM-DD) of the time window used as a filter to retrieve orders scheduled on a specific date, regardless of the timezone.

arrived_at_date_without_tz_tostring nullable

End date (YYYY-MM-DD) of the time window used as a filter to retrieve orders scheduled on a specific date, regardless of the timezone.

limitinteger nullable

Number of Orders to be sent in response

ops_group_handlesstring nullable

List of ops group handles as strings used for fetching associated visits

List of attachments in event

Response

Successful response