HYhypertrack
Geotags

Get Geotags

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

get/geotags/

Request

Query parameters

order_handlestring nullable

String represent order identifier to fetch geotags associated with the identifier

worker_handlestring nullable

String representing the handle for the worker

driver_handlestring nullable

String representing the handle for the driver

ops_group_handlesstring nullable

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

search_termstring nullable

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

device_idstring uuid nullable

String representing the ID of the device

device_namestring nullable

Name of the worker provided during registration

driver_profile_filterstring Encoded JSON nullable

JSON encoded string metadata associated with the worker who generated the geotag

metadata_filterstring Encoded JSON nullable

JSON encoded string metadata associated with the geotag

system_generated_order_handleboolean nullable

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

include_system_generated_order_handleboolean nullable

Flag to include orders where order handle was automatically generated by HT system.

regionstring Encoded JSON nullable

JSON encoded string for region

pagination_tokenstring nullable

Identifier used to fetch the next page of data

from_timestring date-time nullable

ISO 8601 datetime indicating the start time

to_timestring date-time nullable

ISO 8601 datetime indicating the end time

from_datestring nullable

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

to_datestring nullable

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

from_geotag_typestring nullable

String representing type of geotag which corresponds to start of time segment within the order fulfilled through geotags

to_geotag_typestring nullable

String representing type of geotag which corresponds to end of time segment within the order fulfilled through geotags

fetch_attachment_linksboolean

Flag to return attachment links as part of response

include_geotags_with_ordersboolean nullable

Flag to filter geotags which are part of order.

aggregateboolean

Flag set to retrieve aggregated data over the provided time range

limitinteger nullable

Number of Orders to be sent in response

Response

Successful response

pagination_tokenstring nullable

Identifier used to fetch the next page of data

Changes

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