DataStream

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

The DataStream web services creates, modifies, or deletes a data stream.

URI

http://<hostname>/ws/DataStream

Formats

Method Format Description
GET /ws/DataStream List all data streams.
POST /ws/DataStream Create one or more data streams.
PUT /ws/DataStream Create or update a data stream.
DELETE /ws/DataStream/{streamId} Delete a data stream.

Elements

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.

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.

description

Description of the data.

forwardTo

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

dataTtl

Time to live (TTL) in seconds for data points stored in the data stream. A data point expires after the configured amount of time and is automatically deleted.

rollupTtl

Time to live (TTL) in seconds for the aggregate roll-ups of data points stored in the stream. A roll-up expires after the configured amount of time and is automatically deleted.

currentValue

Information about the last recorded data point (not writeable in PUT or POST requests).

Field Description
id Identifier for the data point.
timestamp Data point client timestamp.
serverTimestamp Timestamp when data point was received by the server.
data Data value of the data point.
description Data point description.
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).

Parameters

Name Type Description
pageCursor string Page cursor returned from a previous request that can be used to retrieve the next page of data. Omit on initial call.
size integer Maximum number of items to return. The maximum and default is 1000.
category string Return streams for the specified category: data, metrics, management, or carrier. If you do not use the category parameter, streams for all categories are returned.