Get Geotags

get

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

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

Query Params

order_handle

string | null

Defaults to null

String represent order identifier to fetch geotags associated with the identifier

worker_handle

string | null

Defaults to null

String representing the handle for the worker

driver_handle

string | null

Defaults to null

deprecated

String representing the handle for the driver

ops_group_handles

string | null

Defaults to null

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

search_term

string | null

Defaults to null

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

device_id

uuid | null

Defaults to null

String representing the ID of the device

device_name

string | null

Defaults to null

Name of the worker provided during registration

driver_profile_filter

string | null

Defaults to null

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

metadata_filter

string | null

Defaults to null

JSON encoded string metadata associated with the geotag

system_generated_order_handle

boolean | null

Defaults to null

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

include_system_generated_order_handle

boolean | null

Defaults to null

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

region

string | null

Defaults to null

JSON encoded string for region

pagination_token

string | null

Defaults to null

Identifier used to fetch the next page of data

from_time

date-time | null

Defaults to null

ISO 8601 datetime indicating the start time

to_time

date-time | null

Defaults to null

ISO 8601 datetime indicating the end time

from_date

string | null

Defaults to null

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_date

string | null

Defaults to null

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_type

string | null

Defaults to null

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

to_geotag_type

string | null

Defaults to null

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

fetch_attachment_links

boolean

Defaults to false

Flag to return attachment links as part of response

include_geotags_with_orders

boolean | null

Defaults to false

Flag to filter geotags which are part of order.

aggregate

boolean

Defaults to false

Flag set to retrieve aggregated data over the provided time range

limit

integer | null

Defaults to 100

Number of Orders to be sent in response

Responses

200Successful response

401Authentication error

422Validation error