API Reference

Get all nearby searches performed

get
https://v3.api.hypertrack.com/nearby/v4

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null
Defaults to null

Identifier used to fetch the next page of data

string | null
Defaults to null

Unique id of a nearby search request.

string | null
enum
Defaults to null

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

Allowed:
string | null
Defaults to null

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

string | null
Defaults to null

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

string | null

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

string | null

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

integer | null
≤ 100
Defaults to 100

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

boolean | null
Defaults to false

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

Responses

Updated 7 months ago

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago