🧪 Stop Detection
Retrieve known places visited by vehicles in your accessible fleets, with the total stop count and distinct vehicle count at each location. Only stops matched to a known place are included. Results are ordered by stop count descending (most-visited first). Optionally filter to specific vehicles, a time window, place category, or stop duration.
This endpoint is available for early access. The core schema is stable, but minor details — such as field names or added fields — may change before it becomes generally available. Backward compatibility is not guaranteed.
See API Stability & Versioning for details on provisional endpoints.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Limit results to specific fleets using Catena's fleet IDs. For your own fleet identifiers, use fleet_refs instead To specify multiple values, repeat the parameter for each value (e.g., ?fleet_ids=id1&fleet_ids=id2).
100Limit results to specific fleets using your organization's fleet reference identifiers. To specify multiple values, repeat the parameter for each value (e.g., ?fleet_refs=ref1&fleet_refs=ref2).
100Limit results to a specific provider connection. This is the UUID assigned by Catena when your fleet connects to a TSP.
Limit results to specific vehicles. Maximum: 100 IDs To specify multiple values, repeat the parameter for each value (e.g., ?vehicle_ids=id1&vehicle_ids=id2).
100Return only records that were still active at or after this date and time. Format: ISO 8601 (UTC) Applies filter: ended_at >= active_from_datetime
"2026-07-07T02:04:07.307993Z"
Return only records that started before this date and time. Format: ISO 8601 (UTC) Applies filter: started_at < active_to_datetime
"2026-07-08T02:04:07.308053Z"
Limit results to places with one of the specified categories. To specify multiple values, repeat the parameter (e.g. ?place_categories=FUEL&place_categories=REST).
50Only count stops whose duration is at least this many seconds. Long stops (no confirmed end) always pass this filter.
x >= 0Only count stops whose duration is at most this many seconds. Long stops (no confirmed end) are excluded when this filter is active.
x >= 0Cursor for the next page
Page size
1 <= x <= 1000Response
Successful Response
x >= 0Cursor to refetch the current page
Cursor to refetch the current page starting from the last item
Cursor for the previous page
Cursor for the next page