Water status (saturated/comfort/stress + FC/PWP)

GET /modules/{id}/agronomic-state

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

Path parameters

• id integer required

Response

200

Water status at the latest reading

• state string nullable always present

  saturated: at field capacity or above. comfort: between the two thresholds. stress: below the wilting point. null: no measurement, not enough thresholds to place the value, or a faulty sensor (sensorError).

  Values: saturatedcomfortstress
• value number nullable always present

  Moisture of the summary curve at the latest reading, %, to one decimal place. null: no measurement, or a faulty sensor (sensorError).

• fieldCapacity number nullable always present

  Field capacity threshold drawn on the curve, %. null: not drawn.

• wiltingPoint number nullable always present

  Wilting point threshold drawn on the curve, %. null: not drawn.

• sensorError boolean always present

  true: a sensor included in the average (moisture, or the temperature that corrects it) returns an error code at the latest reading. The value would be wrong: state and value are then null. Do not recommend anything while it stays true.

Errors

• 400

  Invalid parameter

  invalid_id
• 401

  Not authenticated

• 403

  Insufficient scope, or resource outside your company

GET /modules/{id}/agronomic-state

cURL JavaScript Python

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

const response = await fetch(
  'https://api.hub.akuasense.com/v1/modules/1/agronomic-state',
  {
    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/agronomic-state",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

200 400 401 403

{
  "state": "comfort",
  "value": 16.7,
  "fieldCapacity": 27.7,
  "wiltingPoint": 11,
  "sensorError": false
}

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