Root-zone weighted series

GET /modules/{id}/measurements/weighted

Scope readings:read
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Path parameters

id integer required

Query parameters

type string

Quantity to read. tensio: tensiometer probe — tension, its former code, is still accepted. A module that carries only one sensor type serves that one, whatever the type requested.

Values: humiditytemperaturetensio

Default: humidity
start string date-time
end string date-time
interval integer

Bucket (seconds)

Response

200

Root-zone weighted series

module_id integer always present
type string always present

Type actually served (see DepthSeries).

Values: humiditytemperaturetensio
unit string always present

Unit of the main quantity: % (value_vwc, value_vwc_max), °C (value_temp) or kPa (value_tensio). value_mm is always in mm.
start string date-time always present
end string date-time always present
interval_seconds integer nullable always present

See DepthSeries.
data array of WeightedSeriesPoint always present

One instant of the weighted series. Only the fields of the type served are present; values to one decimal place. Sensor error codes: see the general API description.
Show 6 attributes Hide attributes
- time string date-time always present
- value_vwc number nullable
  
  Mean moisture, %, weighted like the hub’s summary curve: per-depth weights entered in the probe’s Settings, otherwise the FAO-56 root water uptake distribution (40/30/20/10 per quarter of the root zone), otherwise a plain average.
- value_vwc_max number nullable
  
  The same average, relative to the maximum the soil can hold, %.
- value_mm number nullable
  
  Water stock, mm: the water held in the declared root zone (crop or manual depth), otherwise in the column the probe monitors. Each sensor is weighted there by the thickness of its soil slice, not by its uptake weight: the figure is therefore directly comparable to rainfall or to an irrigation application. A slice with no value at that instant is estimated from the others. null on a single-sensor probe with no declared root zone.
- value_temp number nullable
  
  Temperature series: weighted average, °C.
- value_tensio number nullable
  
  Tensiometer probe: weighted average, kPa.

Errors

400
Invalid parameter

invalid_idinvalid_date
401
Not authenticated
403
Insufficient scope, or resource outside your company

GET /modules/{id}/measurements/weighted

curl https://api.hub.akuasense.com/v1/modules/1/measurements/weighted \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/modules/1/measurements/weighted',
  {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/modules/1/measurements/weighted",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "module_id": 256,
  "type": "humidity",
  "unit": "%",
  "start": "2026-09-11T19:00:00.000Z",
  "end": "2026-09-11T21:00:00.000Z",
  "interval_seconds": 3600,
  "data": [
    {
      "time": "2026-09-11T19:00:00.000Z",
      "value_vwc": 8.7,
      "value_vwc_max": 18.9,
      "value_mm": 82.5
    },
    {
      "time": "2026-09-11T20:00:00.000Z",
      "value_vwc": 8.8,
      "value_vwc_max": 18.9,
      "value_mm": 82.7
    }
  ]
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_id"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema