Processes API

Find treatment and operating stages within a site. Processes may contain metrics directly, components, or both.

List processes

Use site_id to return the processes configured for one site.

GET/api/processes/v1

curl --digest \
  --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/processes/v1?site_id=55"

{
  "data": [{
    "kind": "process", "id": 71, "name": "Disinfection",
    "parent": { "kind": "site", "id": 55 },
    "order": 4, "attributes": { "internal_keyname": "disinfection" }
  }],
  "links": { "self": "...", "next": null, "prev": null },
  "meta": { "limit": 50, "has_next": false, "has_prev": false }
}

Get one process

GET/api/processes/v1/{processId}

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

links.children opens the process's mixed child collection, which can include components and metrics. Use the dedicated Components and Metrics APIs when you need one kind only.

Process-specific fields

order preserves the configured display order within the site.
attributes.internal_keyname is Waterly's stable internal label for the process.
Use the process ID in process_id filters for components, metrics, and data points.