Get Visits

get

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

visit_id

uuid | null

Defaults to null

Unique identifier representing each visit.

geofence_id

uuid | null

Defaults to null

Geofence Id associated with visit

driver_handle

string | null

Defaults to null

deprecated

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

worker_handle

string | null

Defaults to null

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

device_id

uuid | null

Defaults to null

Device Id associated with visit

order_handle

string | null

Defaults to null

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

place_handle

string | null

Defaults to null

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

pagination_token

string | null

Defaults to null

Identifier used to fetch the next page of data

visited_at_from

date-time | null

Defaults to null

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

visited_at_to

date-time | null

Defaults to null

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

metadata_filter

string | null

Defaults to null

JSON encoded string metadata associated with the visits

region_filter

string | null

Defaults to null

JSON encoded string region associated with the visits

search_term

string | null

Defaults to null

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

aggregate

boolean

Defaults to false

Flag set to retrieve aggregated data over the provided time range

arrived_at_date_without_tz_from

string | null

Defaults to null

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_to

string | null

Defaults to null

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.

limit

integer | null

Defaults to 100

Number of Orders to be sent in response

ops_group_handles

string | null

Defaults to null

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

attachments

array | null

Defaults to null

List of attachments in event

attachments

Responses

200Successful response

401Authentication error

422Validation error