DUET PlatformDocs
API referenceRead APISensors and signals

List sensors

available
GET
/platform/v1/sensors

Lists the sensors in a project's site hierarchy, with the DUET device that each one maps to. Every sensor in the hierarchy is returned, including sensors whose device isn't in DUET yet. With lane=raw_signal, lists every tag the site forwards instead, as returned in the raw_signal lane of /platform/v1/signals.

Authorization

Bearer
headerAuthorizationBearer <token>

Query Parameters

project_id*string

The ID of the project to list sensors for.

lane?"raw_signal"

raw_signal lists every tag the site forwards instead, one row per tag, with the source system's device and the DUET device it maps to. Without it, only sensors in the site hierarchy are listed.

Value in"raw_signal"

Header Parameters

Accept?string

application/json-seq streams one sensor per line instead of returning one JSON array.

Response Body

The sensors, ordered by device ID and then measure, or by tag with lane=raw_signal. Returns one JSON array by default, or one sensor per line when Accept is application/json-seq. With lane=raw_signal, use application/json-seq for a whole site: a large site's catalog is tens of MB as one array.

  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/sensors?project_id=string'
Example Response
[  {    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",    "lane": "raw_signal",    "source": "string",    "hierarchy_id": "string",    "device_id": "string",    "device_name": "string",    "device_type": "string",    "device_key": "string",    "external_ref": "string",    "parent_device_key": "string",    "tag_class": "string",    "value_encoding": "float",    "unit": "string",    "parent_device_id": "string",    "component": "string",    "component_measure": "string",    "sentinel_tag": "default",    "sensor_tag": "string"  }]

List alarm occurrences GET

Lists the alarm occurrences in a project, each with its newest lifecycle events. Rows are sorted by `synced_at`, oldest first. You can filter by status, severity, and site. To read incrementally, use the `updated_since` and `after` watermark. All IDs are DUET IDs.

List signal values GET

Lists time-series values for the project's tags, oldest first. Returns both lanes by default: `raw_signal` has every tag the site forwards, as the source sent it, and `performance` has the tags mapped to a DUET device, scaled. Each row says its `lane` and `resolution`. The response format follows the `Accept` header, as on `/platform/v1/performance-v2`.