Follow a real-time feed of data points for data inputs

get https://api.samsara.com/industrial/data-inputs/data-points/feed

Follow a continuous feed of all data input data points.

Your first call to this endpoint will provide you with the most recent data points for each data input and a pagination object that contains an endCursor.

You can provide the endCursor to the after parameter of this endpoint to get data point updates since that endCursor.

If hasNextPage is false, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates.

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 Params

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.

parentTagIds

array of strings

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

parentTagIds

tagIds

array of strings

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

tagIds

dataInputIds

array of strings

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

dataInputIds

assetIds

array of strings

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

assetIds

Responses

Response body

object

data

array of objects

An array of data input data points. Each object in the array represents a data input and will contain its associated data points.

data

object

assetId

string

Unique identifier for the data input's asset.

dataGroup

string

Data group for this data input.

string

Unique identifier for the data input.

name

string

Name of this data input.

units

string

Units of data for this data input.

fftSpectraPoints

array of objects

List of FFT spectra data points from the data input.

fftSpectraPoints

object

fftSpectra

object

FFT spectrum data

time

string

UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

j1939D1StatusPoints

array of objects

List of active J1939D1 statuses.

j1939D1StatusPoints

object

time

string

UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

value

array of objects

List of active statuses.

value

object

amberLampStatus

number

fmi

number

milStatus

number

occuranceCount

number

protectLampStatus

number

redLampStatus

number

spn

number

txId

number

locationPoints

array of objects

List of location data points from the data input.

locationPoints

object

gpsLocation

object

GPS location information of the data input's datapoint.

time

string

UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

numberPoints

array of objects

List of numeric data points from the data input.

numberPoints

object

time

string

UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

value

double

Numeric value of the data point.

stringPoints

array of objects

List of string data points from the data input.

stringPoints

object

time

string

UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

value

string

String value of the data point.

pagination

object

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.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.samsara.com/industrial/data-inputs/data-points/feed \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of all data points for specified data inputs

defaultUnexpected error.