Get Readings Definitions

An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.

Related guide: Readings.

Rate limit: 10 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Readings under the Readings category when creating or editing an API token. Learn More.

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.

GET /readings/definitions

Get Readings Definitions

cURL

curl --request GET \
  --url https://api.samsara.com/readings/definitions \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "category": "smartTrailer",
      "description": "Engine Speed",
      "entityType": "sensor",
      "ingestionEnabled": true,
      "label": "engineRpm",
      "readingId": "12345",
      "type": "In vel.",
      "enumValues": [
        {
          "label": "Critically High",
          "symbol": "criticallyHigh"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

ids · string

A String of comma separated reading IDs. Include up to 50 readings IDs. If not set, all readings are returned.

entityTypes · string

A list of entity types to return readings for. (Examples: asset, sensor)

Response

200

application/json

OK response.

data · object[] · required

A list of reading definitions.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes