Sensors

Base URL: $BUSINESS_API

The object

idstring · optional
codestring · optional
namestring · optional
device_idstring · optional
kindstring · optional

one of flow, pressure, level, quality

metricstring · optional
unitstring · optional
locationstring · optional

one of abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · optional
dma_idstring · optional
activeboolean · optional
The object
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}

List telemetry sensors

Logs

GET /sensors

Returns a cursor-paginated page of the tenant's telemetry sensors, each with its code, device ID, metric, unit, location in the supply chain and linked asset or DMA. Page with limit and after. Requires the monitoring read permission.

Parameters

kindstring · query · optional

Returns only sensors of this kind: flow, pressure, level or quality.

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 OK

Show attributes
dataarray of Sensor · optional
Show child attributes
idstring · optional
codestring · optional
namestring · optional
device_idstring · optional
kindstring · optional

one of flow, pressure, level, quality

metricstring · optional
unitstring · optional
locationstring · optional

one of abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · optional
dma_idstring · optional
activeboolean · optional
has_moreboolean · optional
next_cursorstring · optional

Errors 400 · 403

Permissions business:monitoring:read · Roles: admin, analyst, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/sensors" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
      "code": "COD-2026-000142",
      "name": "Ana Matsinhe",
      "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
      "kind": "flow",
      "metric": "metric",
      "unit": "unit",
      "location": "abstraction_point",
      "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
      "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
      "active": true
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Register a telemetry sensor

Logs

POST /sensors

Registers an active telemetry sensor whose samples can then be ingested and checked against alarm rules. code, name, device_id, metric and unit are required, and kind must be flow, pressure, level or quality. location must be abstraction_point, treatment_plant, reservoir or distribution and defaults to distribution; asset_id and dma_id are optional. Invalid values return 400 and a conflicting sensor returns 409.

Body application/json

codestring · required
namestring · required
device_idstring · required
kindstring · required

one of flow, pressure, level, quality

metricstring · required
unitstring · required
locationstring · optional
asset_idstring · optional
dma_idstring · optional

Returns

201 OK

Show attributes
idstring · optional
codestring · optional
namestring · optional
device_idstring · optional
kindstring · optional

one of flow, pressure, level, quality

metricstring · optional
unitstring · optional
locationstring · optional

one of abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · optional
dma_idstring · optional
activeboolean · optional

Errors 400 · 403

Permissions business:monitoring:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/sensors" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "location",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg"
}'
Response 201
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}

Get a sensor

Logs

GET /sensors/{id}

Returns one telemetry sensor with its code, device ID, kind, metric, unit, location, linked asset or DMA and whether it is active. A sensor that does not exist in the tenant returns 404.

Parameters

idstring · path · required

ID of the sensor to return.

Returns

200 OK

Show attributes
idstring · optional
codestring · optional
namestring · optional
device_idstring · optional
kindstring · optional

one of flow, pressure, level, quality

metricstring · optional
unitstring · optional
locationstring · optional

one of abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · optional
dma_idstring · optional
activeboolean · optional

Errors 400 · 403

Permissions business:monitoring:read · Roles: admin, analyst, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/sensors/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}