--- title: "Get Geotags" method: GET path: "/geotags/" tags: ["Geotags"] --- # Get Geotags `GET /geotags/` ## Request - Base URL: `https://v3.api.hypertrack.com` - URL: `https://v3.api.hypertrack.com/geotags/` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves Geotags associated with orders. This API provides the ability to filter for Geotags based on a set of query parameters. ## Query parameters - `order_handle` string, nullable - `worker_handle` string, nullable - `driver_handle` string, nullable - `ops_group_handles` string, nullable - `search_term` string, nullable - `device_id` string, uuid, nullable - `device_name` string, nullable - `driver_profile_filter` string, Encoded JSON, nullable - `metadata_filter` string, Encoded JSON, nullable - `system_generated_order_handle` boolean, nullable - `include_system_generated_order_handle` boolean, nullable - `region` string, Encoded JSON, nullable - `pagination_token` string, nullable - `from_time` string, date-time, nullable - `to_time` string, date-time, nullable - `from_date` string, nullable - `to_date` string, nullable - `from_geotag_type` string, nullable - `to_geotag_type` string, nullable - `fetch_attachment_links` boolean - `include_geotags_with_orders` boolean, nullable - `aggregate` boolean - `limit` integer, nullable ## Response `200` Successful response - GetGeotagsResponse - `orders` GeotagOrder[], nullable: Array of Orders fulfilled in the given time range - `order_handle` string, required: String representing the order - `last_geotag_recorded_at` string, required: ISO 8601 date when the last geotag for the order was created - `distance` integer, required: Distance travelled for the order - `duration` integer, required: Duration to be tracked for the order - `driver_handle` string: String representing the handle for the driver - `worker_handle` string: String representing the handle for the worker - `driver_name` string: String representing the name of the driver - `worker_name` string: String representing the name of the driver - `device_id` string, uuid, required: String representing the ID of the device - `tracking_rate` number: Driver tracking rate during the lifespan of the order - `ops_group_handle` string: String representing the ops group handle - `system_generated_order_handle` boolean, required: Boolean representing whether the handle was automatically generated by HT system or sent along with geotag data - `geotags` Geotag[]: List of geotags associated with order - `geotag_id` string, uuid, required: Unique ID to identify a geotag - `driver_handle` string: String representing the handle for the driver - `worker_handle` string: String representing the handle for the worker - `recorded_at` string, required: ISO 8601 date when the geotag was created - `device_id` string, uuid, required: String representing the ID of the device - `metadata` object: Optional metadata associated with the geotag - `location` LocationWithoutRadius, required - `address` string, nullable: Address for the location - `geometry` union: Location geometry - LocationGeometry - `type` 'Point', required: Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude] - unknown - `place_handle` string: String representing the handle for the worker - `expected_location` LocationWithoutRadius - `address` string, nullable: Address for the location - `geometry` union: Location geometry - LocationGeometry - `type` 'Point', required: Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude] - unknown - `start_location` LocationWithoutRadius - `address` string, nullable: Address for the location - `geometry` union: Location geometry - LocationGeometry - `type` 'Point', required: Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude] - unknown - `region` Region - `country` string, required: Country - `city` string, nullable: City - `state` string, nullable: State - `distance` integer: Distance from the tracking start for the geotag - `duration` integer: Time taken from start location to this geotag location - `deviation` integer: Haversine deviation in meters from the expected location - `tracking_rate` number: Driver tracking rate during the lifespan of the geotag - `geotag_type` string: String representing type of Geotag - `order_handle` string: String representing order handle with which the geotag is associated - `driver_name` string: String representing the name of the driver - `ops_group_handle` string: String representing the ops group handle - `system_generated_order_handle` boolean: Boolean representing whether the handle was automatically generated by HT system or not - `timezone` string, nullable: Timezone associated with this geotag - `attachments` union[], nullable: Attachments associated with this geotag - union - ImageAttachmentResponse - `type` 'image', required: Type of attachment - `url` string, required: Image link - `caption` string, nullable: Caption for the image - `attachment_id` string, nullable - NoteAttachmentResponse - `type` 'note', required: Type of attachment - `data` string, required: Text for the note - `attachment_id` string, nullable - SignatureAttachmentResponse - `type` 'signature', required: Type of attachment - `url` string, required: Signature image link - `attachment_id` string, nullable - `tracking_summary` union: Tracking summary of activities during the lifespan of geotag - GeotagTrackingSummary - `stop` union: Tracking summary of stops during the geotag lifespan. - ActivitySummary - … - unknown - `walk` union: Tracking summary of walks during the geotag lifespan. - ActivitySummary - … - unknown - `drive` union: Tracking summary of drives during the geotag lifespan. - DriveSummary - … - unknown - unknown - `pagination_token` string, nullable: Identifier used to fetch the next page of data - `aggregate` union: Combined aggregate metrics for geotags and orders in the given time range - GeotagOrderAggregate - `count` integer, required: Number of orders generated in the given time range - `distance` GeotagStats - `mean` number, nullable: Average value for the metric - `min` number, nullable: Minimum value for the metric - `max` number, nullable: Maximum value for the metric - `stdev` number, nullable: Standard deviation for the metric - `mean_by_driver` number, nullable: Average value per worker for the metric - `sum` number, required: Total value of the metric - `duration` GeotagStats - `mean` number, nullable: Average value for the metric - `min` number, nullable: Minimum value for the metric - `max` number, nullable: Maximum value for the metric - `stdev` number, nullable: Standard deviation for the metric - `mean_by_driver` number, nullable: Average value per worker for the metric - `sum` number, required: Total value of the metric - `active_duration` GeotagStats - `mean` number, nullable: Average value for the metric - `min` number, nullable: Minimum value for the metric - `max` number, nullable: Maximum value for the metric - `stdev` number, nullable: Standard deviation for the metric - `mean_by_driver` number, nullable: Average value per worker for the metric - `sum` number, required: Total value of the metric - `outage_duration` GeotagStats - `mean` number, nullable: Average value for the metric - `min` number, nullable: Minimum value for the metric - `max` number, nullable: Maximum value for the metric - `stdev` number, nullable: Standard deviation for the metric - `mean_by_driver` number, nullable: Average value per worker for the metric - `sum` number, required: Total value of the metric - `tracking_rate` number: Tracking rate of the driver during the lifespan of the orders - `deviation` GeotagStats - `mean` number, nullable: Average value for the metric - `min` number, nullable: Minimum value for the metric - `max` number, nullable: Maximum value for the metric - `stdev` number, nullable: Standard deviation for the metric - `mean_by_driver` number, nullable: Average value per worker for the metric - `sum` number, required: Total value of the metric - `geotags` GeotagAggregate - `count` integer: Number of geotags generated in the given time range - `count_mean` number: Mean number of geotags in an order in the given time range - `drivers` DriversAggregate - `count` integer: Total number of drivers - `workers` DriversAggregate - `count` integer: Total number of drivers - `outage_summary` OrderOutageSummary[], nullable: List of outages experienced during the specified time range. - `duration` integer, required: Sum total duration of all outages experienced with this `code` in the specified time range. - `distance` integer: Sum total (estimated) distance covered during all outages experienced with this `code` in the specified time range. - `code` string, required: Code indicating the type of outage - `label` string, required: Text indicating the type of outage - `description` string, required: Text describing the outage. - `category` 'behavioural' | 'adversarial' | 'reachability' | 'os' | 'sporadic' | 'null', nullable: String indicating the category of outage - unknown ## Other responses - `400`: Validation error - `401`: Authentication error --- [API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)