Expected Visits

Last updated 7 days ago

This product feature is still under development and is not available in production. Please reach out to us on Slack if you want an early access.

post
Create place

https://api.hypertrack.com
/v1/places
Create a new Place object where you expect the visit to happen
Request
Response
Headers
Authentication
required
string
Body Parameters
coordinates
required
object
GeoJSON with latitude and longitude
name
optional
string
Name of the place
address
optional
object
JSON with address of the place
200: OK
Cake successfully retrieved.
{
"name": "Cake's name",
"recipe": "Cake's recipe name",
"cake": "Binary cake"
}
302: Found
304: Not Modified
400: Bad Request
404: Not Found
Could not find a cake matching this query.
{
"message": "Ain't no cake like that."
}

post
Create expected visit

https://api.hypertrack.com
/v1/expected_visit
Created expected visit(s) to a given place
Request
Response
Body Parameters
place_id
required
string
device_id
optional
string
occurrence
required
string
completion
required
string
metadata
optional
object
200: OK

get
Get an expected visit

https://api.hypertrack.com
/v1/expected_visit
Get expected visit object for a given expected_visit_id
Request
Response
Path Parameters
expected_visit_id
required
string
200: OK

get
Get expected visits for a device

https://api.hypertrack.com
/v1/expected_visit
Get expected visits for a given device_id; they are returned in the order the device is expected to visit the places
Request
Response
Query Parameters
device_id
required
string
Device id for which you want to get expected visits
occurrence
optional
string
Pass once or always if you want to filter the output by occurrencea
200: OK