HYhypertrack
Nearby

Get all nearby searches performed

This API returns a list of all nearby searches performed. The response includes the search parameters, the results of the search. The API is useful for tracking the history of nearby searches and for debugging purposes. The API returns a paginated list of nearby searches, with the ability to filter by date range and search parameters.

get/nearby/v4

Request

Query parameters

pagination_tokenstring nullable

Identifier used to fetch the next page of data

request_idstring nullable

Unique id of a nearby search request.

search_type'eta' | 'region' | 'null' nullable

Type of nearby search. 'eta' for finding estimates of nearby workers, 'region' for finding nearby workers.

order_handlestring nullable

Order handle used to search nearby workers for. This can later be used for tracking and associate nearby requests with corresponding orders.

place_handlestring nullable

Place handle used to search nearby workers for. This can later be used for tracking and associate nearby requests with corresponding places.

from_datestring nullable

Start date of the search in yyyy-mm-dd format. default: 3 days ago utc date

to_datestring nullable

End date of the search in yyyy-mm-dd format. default: todays utc date

limitinteger nullable

Maximum number of items to return. If not provided, it will default to 100.

aggregateboolean nullable

If true, the response will be aggregated by date and search type. If false, the response will be returned as is.

Response

Successful response

pagination_tokenstring nullable

Token to be used for pagination. If present, it indicates that there are more pages of results available.

Changes

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