Get places

get

https://v3.api.hypertrack.com/places/v1/

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

Query Params

place_handles

string | null

Defaults to null

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

search_term

string | null

Defaults to null

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

name

string | null

Defaults to null

Filter places by name (case-insensitive partial match)

lat

number | null

Defaults to null

latitude of location around which places should be searched

lon

number | null

Defaults to null

longitude of location around which places should be searched

radius

integer | null

Defaults to null

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

min_skew

number | null

Defaults to null

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

string | null

enum

Defaults to null

Key on which result must be sorted.

Allowed:

sort_direction

string | null

enum

Defaults to null

Sort route responses by asc or desc on the created_at timestamp

Allowed:

geofence_type

string | null

enum

Defaults to null

Filter to fetch the specified geofence type.

Allowed:

has_suggested_places

boolean | null

Defaults to null

Filter to fetch the places which has suggested geofences

suggestion_type

string | null

Defaults to null

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

aggregate

boolean | null

Defaults to null

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

pagination_token

string | null

Defaults to null

Identifier used to fetch the next page of data

limit

integer | null

0 to 100

Defaults to null

Maximum number of results to be returned.

from_date

string | null

Defaults to null

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_date

string | null

Defaults to null

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_config

string | null

Defaults to null

Worker detection config as json encoded string

Responses

200Successful response

401Authentication error

422Validation error