Components API

Discover equipment and logical groupings inside a process, then use a component ID to find its metrics or data points.

List components

Filter by process_id to list equipment or groupings within one process.

GET/api/components/v1

curl --digest \
  --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/components/v1?process_id=71"

{
  "data": [{
    "kind": "component", "id": 82, "name": "Chlorine Contact Basin",
    "parent": { "kind": "process", "id": 71 },
    "order": 1, "attributes": { "internal_keyname": "contact_basin" }
  }],
  "links": { "self": "...", "next": null, "prev": null },
  "meta": { "limit": 50, "has_next": false, "has_prev": false }
}

Get one component

GET/api/components/v1/{componentId}

curl --digest --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/components/v1/82"

Follow links.children to discover metrics under this component, or pass component_id=82 directly to the Metrics or Data Points API.

Component-specific fields

parent.id identifies the containing process.
order preserves component display order within the process.
attributes.internal_keyname is Waterly's stable internal label.