Skip to main content

List data streams

GET 
/api/v1/orgs/{orgId}/devices/{deviceId}/data-streams

Retrieve all data streams for a specific device. For user-managed streams (managedBy = User), dataSource is null when the stream is not yet bound to a source.

Parameters

  • deviceId (string, required): Unique ID of the device. Example: 74fe488d5d35
  • skipCount (int, optional): Number of records to skip for pagination (default: 0).
  • maxResultCount (int, optional): Maximum number of records to return (default: 10, max: 100).

Response Fields:

  • totalCount (int): Total number of data streams for the device, ignoring paging.
  • items (array): The page of data streams. Each item:
    • dataStreamId (Guid): Unique identifier of the data stream.
    • dataStreamName (string): Unique name of the data stream within the device.
    • displayName (string, nullable): Human-readable label for the data stream.
    • description (string, nullable): Description of the data stream.
    • unitDisplay (string, nullable): Display unit of the measured value (e.g. °C, %).
    • dataType (string): Data type of the stream value (e.g. double, boolean, integer, string, long, data-pack, blob).
    • recordToDataLake (boolean): Whether values are persisted to the data lake.
    • managedBy (string): Management ownership (User or System).
    • dataSource (object, nullable): Lineage information; null when not yet bound to a source.

Responses

  • 200 OK: Returns a paged list of data streams.
  • 400 Bad Request: Invalid query parameters.

Security

  • This API requires authentication.

Request​

Responses​

Returns a paged list of data streams: totalCount, and items[] with each DataStreamDto's dataStreamId, dataStreamName, displayName, description, unitDisplay, dataType, recordToDataLake, managedBy, dataSource.