Skip to content

List Location Stays

GET
/users/{user_id}/location-stays
curl --request GET \
--url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/location-stays?limit=200&live=false&roam_radius_m=150&min_dwell_minutes=3&bridge_gap_minutes=240'
user_id
required
User Id
string format: uuid
after
Any of:
string format: date-time

Window start (default: 30 days ago)

before
Any of:
string format: date-time
limit
Limit
integer
default: 200 >= 1 <= 1000
live
Live

Re-derive from samples, not persisted rows

boolean

Re-derive from samples, not persisted rows

roam_radius_m
Roam Radius M
number
default: 150 > 0 <= 5000
min_dwell_minutes
Min Dwell Minutes
number
default: 3 <= 1440
bridge_gap_minutes
Bridge Gap Minutes

Max co-located silence (min) bridged as continuous dwell

number
default: 240 > 0 <= 1440

Max co-located silence (min) bridged as continuous dwell

Successful Response

Media typeapplication/json
Response List Location Stays Users User Id Location Stays Get
Array<object>
StayRead

A derived dwell cluster — where the user stayed and for how long.

object
arrived_at
required
Arrived At
string format: date-time
departed_at
required
Departed At
string format: date-time
duration_minutes
required
Duration Minutes
number
lat
required
Lat
number
lng
required
Lng
number
place_name
Any of:
string
place_source
Any of:
string
sample_count
required
Sample Count
integer
Examplegenerated
[
{
"arrived_at": "2026-04-15T12:00:00Z",
"departed_at": "2026-04-15T12:00:00Z",
"duration_minutes": 1,
"lat": 1,
"lng": 1,
"place_name": "example",
"place_source": "example",
"sample_count": 1
}
]

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}