HYhypertrack
Places

Get places

Get places with filters. Response includes the 'name' field for each place if available.

get/places/v1/

Request

Query parameters

place_handlesstring nullable

List of place handles as comma separated strings used for fetching associated Places

search_termstring nullable

Keyword to match against place handle (or place id) OR name OR metadata

namestring nullable

Filter places by name (case-insensitive partial match)

latnumber nullable

latitude of location around which places should be searched

lonnumber nullable

longitude of location around which places should be searched

radiusinteger nullable

radius around location which places should be searched, if given metadata is ignored

metadatastring nullable

metadata of the order as json encoded string

min_skewnumber nullable

Minimum skew to filter for. Skew in inferred geofence can be between 0 and 1. 0 mean no skew, i.e. perfect overlap and 1 means no overlap

sort_by'order_count' | 'skew' | 'last_updated' | 'null' nullable

Key on which result must be sorted.

sort_direction'asc' | 'desc' | 'null' nullable

Sort route responses by asc or desc on the created_at timestamp

geofence_type'Point' | 'Polygon' | 'null' nullable

Filter to fetch the specified geofence type.

has_suggested_placesboolean nullable

Filter to fetch the places which has suggested geofences

suggestion_typestring nullable

Filter to fetch places by suggestion type. Comma-separated list of: 'manual', 'inferred', 'bounding_box'

aggregateboolean nullable

Whether to return aggregates, i.e. count of places

pagination_tokenstring nullable

Identifier used to fetch the next page of data

limitinteger nullable

Maximum number of results to be returned.

from_datestring nullable

Start date (YYYY-MM-DD) of the time window used as a filter to retrieve places visited 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 places visited on a specific date, regardless of the timezone.

visit_detection_configstring nullable

Worker detection config as json encoded string

Response

Successful response

pagination_tokenstring nullable

Identifier used to fetch the next page

Changes

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