DataPoint

The DataPoint API is a pre-version 1 API used to get, create, modify, or delete data points. Data points created by the API are supported. However, when creating new data streams, use the v1/streams API.

The DataPoint web service lists, creates, or deletes data points within a data stream.

URI

http://<hostname>/ws/DataPoint

Formats

Method Format Description
GET /ws/DataPoint/{streamId} List all data points for a data stream.
POST /ws/DataPoint/{streamId} Create one or more data points in a data stream.
DELETE /ws/DataPoint/{streamId} Delete an existing data point within a data stream.

Elements

id

Identifier for the data point.

cstId

Remote Manager identifier for the customer.

streamId

Full path for the stream that contains the data points. Typically this is the data stream that the data point belongs to, but if you are using replication (forwardTo) it may be different.

timestamp

Client-assigned timestamp. If there is no client-assigned timestamp, the serverTimestamp value is used.

serverTimestamp

Server-assigned timestamp that indicates when the data point was stored on the server. Not writable by the client.

data

Data value for the data point.

description

Description of the data.

quality

User-defined 32-bit integer value representing the quality of the data in the data point.

location

Geo-location information associated with the data point which indicates the location when the data point was recorded. Geo-location is represented as a comma-delimited list of floats in order of lat, long, elevation (degrees, degrees, meters).

dataType

Type of data stored in the data stream.

  • Integer: data can be represented with a network (= big-endian) 32-bit two’s-complement integer
  • Long: data can be represented with a network (= big-endian) 64-bit two’s complement integer
  • Float: data can be represented with a network (= big-endian) 32-bit IEEE754 floating point
  • Double: data can be represented with a network (= big-endian) 64-bit IEEE754 floating point
  • String: UTF-8
  • Binary
  • Unknown

units

User-defined name for the units in which data is reported.

forwardTo

Comma-delimited list of data streams to which to forward the data points.

Parameters

Name Type Description
startTime timestamp Start time (inclusive) in ISO 8601 or epoch (long).
endTime timestamp End time (exclusive) in ISO 8601 or epoch (long).
timeline string Timestamps to use in the request: client or server. The default is client.
pageCursor string Cursor to get the next page of devices. Omit on initial call.
size integer Number of items to return. The maximum and default is 1000.
order string Return streams ordered by ID (asc | desc). The default is ascending (asc).
timezone string Timezone in which to calculate rollups. Applies only to rollups with intervals of day or longer.
rollupInterval string Rollup interval: half, hour, day, week, or month. The default is hour.
rollupMethod string Rollup method: sum, average, min, max, count, or standarddev. The default is average.