--- title: "Follow a feed of equipment stats" method: GET path: "/fleet/equipment/stats/feed" tags: ["Equipment"] --- # Follow a feed of equipment stats `GET /fleet/equipment/stats/feed` ## Request - Base URL: `https://api.samsara.com` - URL: `https://api.samsara.com/fleet/equipment/stats/feed` - Auth: HTTP bearer Follow a continuous feed of all equipment stats. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we'd suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. ## Query parameters - `after` string - `parentTagIds` string[] - `tagIds` string[] - `equipmentIds` string[] - `types` string[], required ## Response `200` The feed of equipment stats and pagination information - EquipmentStatsListResponse: A time-series of equipment stats and pagination information - `data` EquipmentStatsListResponseData[], required: Time-series of stats for the specified units of equipment and stat types. - `engineRpm` EquipmentEngineRpm[]: A time-series of engine RPM readings for the given unit of equipment. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: The revolutions per minute of the engine. - `engineSeconds` EquipmentEngineSeconds[]: [DEPRECATED] Please use either `gatewayEngineSeconds`, `obdEngineSeconds`, or `gatewayJ1939EngineSeconds`. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power and an offset provided manually through the Samsara cloud dashboard. - `engineStates` EquipmentEngineState[]: [DEPRECATED] Please use either `gatewayEngineStates` or `obdEngineStates`. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` 'Off' | 'On', required: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Valid values: `Off`, `On`. - `engineTotalIdleTimeMinutes` EquipmentEngineTotalIdleTimeMinutes[]: A time-series of engine total idle time minutes. (Beta) - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: Total time in minutes that the engine has been idling since the device was installed. This value is calculated based on the time the engine has been running while the vehicle is not in motion. - `fuelPercents` EquipmentFuelPercent[]: A time-series of fuel percent level changes for the given unit of equipment. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: The percent of fuel in the unit of equipment. - `gatewayEngineSeconds` EquipmentGatewayEngineSeconds[]: A time-series of engine seconds readings for the given unit of equipment as an approximate based on readings from the AG26's aux/digio cable. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: The number of seconds an engine has been running as detected via engine state. Used in combination with an offset provided manually through the Samsara cloud dashboard. Useful for when assets do not report engine hours over the J1939 network. The Engine Speed SPN must be available from the ECU for this parameter to properly calculate seconds. This is supported with the following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14. - `gatewayEngineStates` EquipmentGatewayEngineState[]: A time-series of engine state changes (as read from the AG26's aux/digio cable) for the given unit of equipment. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` 'Off' | 'On', required: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Valid values: `Off`, `On`. - `gatewayJ1939EngineSeconds` EquipmentGatewayJ1939EngineSeconds[]: A time-series of engine seconds readings for the given unit of equipment as an approximate based on readings from the AG26's CAT/J1939 cable. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: The number of seconds an engine has been running as detected via aux input 1 active state. Used in combination with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: AG24/AG26/AG46P + APWR cable (Auxiliary engine configuration required) AG52/AG53 + BPWR/BEQP cable (Auxiliary engine configuration required). - `gps` EquipmentStatsGps[]: A time-series of GPS locations. - `address` AddressTinyResponse: Address book entry, if one exists - `id` string: Address book identifier - `name` string: Name of this address book entry - `headingDegrees` number, double: Heading of the asset in degrees. - `latitude` number, double, required: GPS latitude represented in degrees - `longitude` number, double, required: GPS longitude represented in degrees - `reverseGeo` ReverseGeo: Reverse geocoded information. - `formattedLocation` string: Formatted address of the reverse geocoding data. - `speedMilesPerHour` number, double: GPS speed of the asset in miles per hour. - `time` string, required: UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`. - `gpsOdometerMeters` EquipmentGpsOdometerMeters[]: A time-series of GPS odometer readings for the given unit of equipment. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. - `id` string, required: Unique Samsara ID for the equipment. - `name` string, required: Name of the equipment. - `obdEngineSeconds` EquipmentObdEngineSeconds[]: A time-series of engine seconds readings for the given unit of equipment directly from on-board diagnostics. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` integer, required: The number of seconds the engine has been running as reported directly from on-board diagnostics. This is supported with the following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14 - `obdEngineStates` EquipmentObdEngineState[]: A time-series of engine state changes (as read from on-board diagnostics) for the given unit of equipment. - `time` string, required: UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format. - `value` 'Off' | 'On' | 'Idle', required: The state of the engine read from on-board diagnostics. Valid values: `Off`, `On`, `Idle`. - `pagination` PaginationResponse, required: Pagination parameters. - `endCursor` string, 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 - `default`: Error 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)