Skip to content
docs

Series per depth

GET /modules/{id}/measurements
  • 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)

  • raw boolean

    true: every measurement, with no per-interval averaging, each one calibrated individually. At most 100,000 readings (one per depth and per instant), oldest first: beyond that, the END of the period is missing — split it up. Default: per-interval averages.

    Default: false

Response

200

Series per depth

  • module_id integer always present
  • type string always present

    Type ACTUALLY served: a module that carries only one sensor type returns that one, whatever type was requested (a tensiometer queried for humidity returns tensio).

    Values: humiditytemperaturetensio
  • unit string always present

    Unit of the main quantity: % for moisture (_vwc, _vwc_max), °C for temperature (_temp), kPa for a tensiometer probe (_tensio). depthN_mm is always in mm.

  • start string date-time always present
  • end string date-time always present
  • interval_seconds integer nullable always present

    Requested interval. null: automatic interval, about 60 points over the period and never less than 5 minutes — or a non-averaged series (raw=true).

  • data array of DepthSeriesPoint always present

    One instant: time, then keys per depth N, in cm, each named after its quantity. Moisture: depthN_vwc, depthN_vwc_max, depthN_mm, depthN_ru_percent. Temperature: depthN_temp. Tensiometer: depthN_tensio. Values to one decimal place. A depth with no calibrated value at that instant is simply absent. Sensor error codes: see the general API description.

    Show attribute Hide attributes
    • time string date-time always present

Errors

  • 400

    Invalid parameter

    invalid_idinvalid_date
  • 401

    Not authenticated

  • 403

    Insufficient scope, or resource outside your company