---
title: "Get route events stream"
method: GET
path: "/route-events/stream"
tags: ["Route Events"]
---

# Get route events stream

`GET /route-events/stream`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/route-events/stream`
- Auth: HTTP bearer

Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used in subsequent requests to fetch events on all routes that occurred after the last retrieved event. An initial request (with empty after and startTime parameters) will return events from the past 24 hours.

 <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 

 **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

## Query parameters

- `after` string
- `startTime` string
- `limit` integer
- `includeExternalIds` boolean

## Response `200`

OK response.

- RoutesGetRouteEventsStreamResponseBody
  - `data` RouteEventResponseResponseBody[], required: List of route event objects.
    - `eventDetails` RouteEventDetailsResponseBody: Contains additional information specific to the event type.
      - `stopEtaUpdated` StopEtaUpdatedEventDetailsResponseBody: Details for stop ETA updated events.
        - `etaMs` string, required: Estimated arrival time in milliseconds since epoch.
        - `etaUpdatedAtMs` string, required: Time when the ETA was updated in milliseconds since epoch.
      - `stopTaskCompleted` StopTaskCompletedEventDetailsResponseBody: Details for stop task completed events.
        - `taskId` string, required: ID of the completed stop task.
        - `taskType` 'form' | 'document', required: Type of the completed stop task. Valid values: `form`, `document`
      - `stopTaskSkipped` StopTaskSkippedEventDetailsResponseBody: Details for stop task skipped events.
        - `taskId` string, required: ID of the skipped stop task.
        - `taskType` 'form' | 'document', required: Type of the skipped stop task. Valid values: `form`, `document`
    - `eventTime` string, date-time, required: Time the event was processed in RFC 3339 format
    - `eventType` 'stopArrived' | 'stopCompleted' | 'stopEnRoute' | 'stopSkipped' | 'stopTaskCompleted' | 'stopTaskSkipped' | 'stopEtaUpdated' | 'unspecified', required: Type of the event that occurred. Valid values: `stopArrived`, `stopCompleted`, `stopEnRoute`, `stopSkipped`, `stopTaskCompleted`, `stopTaskSkipped`, `stopEtaUpdated`, `unspecified`
    - `happenedAtTime` string, date-time, required: Time the event happened in RFC 3339 format
    - `id` string, required: Unique ID of the route event.
    - `route` RouteEventRouteResponseResponseBody, required: Normalized route object this event belongs to.
      - `externalIds` object: A map of external ids
      - `id` string, required: ID of the route this event belongs to.
    - `stop` RouteEventStopResponseResponseBody: Normalized stop object this event belongs to.
      - `externalIds` object: A map of external ids
      - `id` string, required: ID of the stop this event belongs to.
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)