v1
latestOpenAPI 3.0.42026-08-04342835917.6 KBRapid
Gets the anchor rapid and its surrounding rapids within the results slice, in the order and filter the results grid renders, so the explorer can step neighbour-to-neighbour.
Navigation follows the grid's default order (flagged rapids first, then by id) over the given correlation slice. Returns 404 when the rapid is not part of the filtered slice.
get/rapid/{rapidId}/navigation
Path parameters
rapidIdstring required
The rapid to anchor navigation on.
Query parameters
correlationIdstring required
The correlation id whose result slice to navigate.
statesRapidState[]
Optional rapid states to filter by; all states are included when omitted.
windowinteger
The maximum number of neighbours to return on each side.
includeNotAcceptedboolean
When true, not-accepted responses count toward the anchor's sample and aggregation.
includeOverflowboolean
When true, overflow responses count toward the anchor's sample and aggregation.
Response
OK