SAsamsara
Industrial

List historical data points for data inputs

Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs.

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.

To use this endpoint, select Read Equipment Statistics under the Equipment 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>

get/industrial/data-inputs/data-points/history

Request

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

Query parameters

startTimestring required

A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endTimestring required

An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

afterstring

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.

parentTagIdsstring[]

A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

tagIdsstring[]

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

dataInputIdsstring[]

A comma-separated list of data input IDs. Example: dataInputIds=1234,5678

assetIdsstring[]

A comma-separated list of industrial asset UUIDs. Example: assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544

Response

List of all data points for the specified data inputs and time range.

Example response

{
  "data": [
    {
      "assetId": "74771078-5edb-4733-88f2-7242f520d1f1",
      "dataGroup": "Flow",
      "name": "Pump Flow",
      "units": "Gallons Per Minute",
      "fftSpectraPoints": [
        {
          "time": "2020-01-27T07:06:25Z"
        }
      ],
      "j1939D1StatusPoints": [
        {
          "time": "2020-01-27T07:06:25Z"
        }
      ],
      "locationPoints": [
        {
          "gpsLocation": {
            "formattedAddress": "350 Rhode Island St, San Francisco CA, 94103",
            "gpsMetersPerSecond": 35.5,
            "headingDegrees": 91.2,
            "latitude": 42.44817,
            "longitude": -71.224716,
            "place": {
              "city": "San Francisco",
              "houseNumber": "350",
              "neighborhood": "Castro",
              "poi": "400",
              "postcode": "94103",
              "state": "CA",
              "street": "Rhode Island"
            }
          },
          "time": "2020-01-27T07:06:25Z"
        }
      ],
      "numberPoints": [
        {
          "time": "2020-01-27T07:06:25Z",
          "value": 1992.0506
        }
      ],
      "stringPoints": [
        {
          "time": "2020-01-27T07:06:25Z",
          "value": "On"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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