DataService

GetData v1

Query data

post/api/v1/data

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/data
  • Auth: HTTP bearer

Request body

startTimestring date-time

Required. The starting timestamp of the data to retrieve. This is an inclusive bound.

endTimestring date-time

Required. The end timestamp of the data to retrieve. This is an exclusive bound.

sampleMsinteger

The rate to sample the returned data at. The data is sampled using LTTB which will return one point approximately every sample_ms milliseconds that retains the shape of the raw data. Sampling is only supported for numeric data types, if sample_ms is provided for non-numeric data, it will be ignored and the full-fidelity data will be returned. A value of 0 disables sampling and returns the full unsampled dataset. This is recommended for external data analysis where full fidelity is required, as opposed to plotting where downsampling is typically sufficient.

pageSizeinteger

The maximum number of channel values to return. The service may return fewer than this value. If unspecified, at most 10,000 values will be returned. The maximum value is 1,000,000; values above 1,000,000 will be coerced to 1,000,000. For variable data types (i.e. string channels), at most page_size elements will be read, or 1MB, whichever occurs first.

pageTokenstring

A page token, received from a previous GetData call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to GetData must match the call that provided the page token.

Response

A successful response.

nextPageTokenstring

Changes

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