Beta APIs

[beta] Ingest Readings

Ingest new readings. This endpoint allows the ingestion of batches of readings.

Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.

Readings that currently support ingestion (by category):

<details> <summary><strong>ingestible</strong></summary>
  • batteryVoltage
  • coolantTemp
  • ecuFuelLevelMillipercent
  • engineHours
  • engineRpm
  • engineState (values: off | running | idling)
  • faultCodes
  • fuelLevelPerc
  • gps
  • odometerEcu
  • oilPressure
</details>

When ingesting GPS location data, use the readingID 'gps'. The value object must contain the following fields: 'latitude' (decimal degrees), 'longitude' (decimal degrees), and 'speed' (meters per second).

Related guide: Readings.

<b>Rate limit:</b> 10 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 Write Readings under the Readings 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.

post/readings

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": [
    {
      "entityId": "123451234512345",
      "entityType": "asset",
      "externalId": "maintenanceId:250020",
      "happenedAtTime": "2023-10-27T10:00:00Z",
      "readingId": "airInletPressure",
      "value": "off"
    }
  ]
}

Response

Created response.

Changes

No recorded changes to this operation across all 1 revision of this API.