Annotations de courbe

GET /modules/{id}/annotations

Scope annotations:read
Clé API x-api-key
URL de base https://api.hub.akuasense.com/v1

Paramètres de chemin

id integer obligatoire

Paramètres de requête

chartType string

Courbe dont on veut les annotations (voir AnnotationChartType). tension reste accepté pour tensio.

Valeurs : humidityhumidity-detailhumidity-heatmaptemperaturetensio

Par défaut : humidity

Réponse

200

Annotations de la courbe, de la plus ancienne à la plus récente, toutes unités confondues : chacune porte son unit

data tableau d’Annotation toujours présent

Un tracé posé sur une courbe du hub : ligne, zone ou texte. Il appartient à sa courbe (chart_type) et à l’unité dans laquelle il a été tracé (unit). Une h-line dont style.fill vaut threshold1 ou threshold2 est un seuil agronomique (capacité au champ, point de flétrissement), toujours en vwc ; sur la courbe humidity, le second arme une alerte.
Afficher les 14 attributs Masquer les attributs
- id string uuid toujours présent
- module_id integer toujours présent
- probe_id any peut être null toujours présent
  
  Obsolète : toujours null.
- chart_type string toujours présent
  
  Courbe du hub qui porte l’annotation. humidity : courbe de synthèse, l’humidité pondérée — c’est elle qui porte les seuils agronomiques. humidity-detail : humidité par profondeur. humidity-heatmap : carte de chaleur. temperature : température. tensio : sonde tensiométrique (tension reste accepté en entrée).
  
  Valeurs : humidityhumidity-detailhumidity-heatmaptemperaturetensio
- type string toujours présent
  
  Forme du tracé, telle que la dessinent les outils du hub : h-line (ligne horizontale), v-line (verticale), segment, ray (demi-droite), infinite (droite), arrow, h-free, rect (zone), text. D’anciennes annotations portent line.
- p1 tableau d’any toujours présent
  
  Un point de la courbe, [instant, valeur] : l’instant en millisecondes depuis le 1er janvier 1970 UTC, la valeur dans l’unité de l’annotation (unit ; en humidité, % de VWC par défaut).
- p2 tableau d’any peut être null toujours présent
  
  Second point, pour les tracés qui en ont deux.
- unit string peut être null toujours présent
  
  Unité de la hauteur des points (p1, p2), c’est-à-dire la vue de la courbe à laquelle l’annotation appartient : elle ne s’affiche que dans cette unité. Courbes humidity et humidity-detail seulement : vwc — humidité volumique, %, l’unité de référence, celle de l’alerte et de l’état hydrique —, vwc_max — part de la saturation du sol, % —, mm. null sur les autres courbes, qui n’ont qu’une unité.
  
  Valeurs : vwcvwc_maxmmnull
- content object toujours présent
  
  Style et texte du tracé : { style, text }.
- user_id string toujours présent
  
  Auteur : userId d’un membre (GET /company/users).
- created_at string date-time toujours présent
- updated_at string date-time toujours présent
- style object
  
  Copie de content.style, présente quand il existe.
- text string
  
  Copie de content.text, présente quand il existe.

Erreurs

400
Paramètre invalide

invalid_id
401
Non authentifié
403
Scope insuffisant ou ressource hors société

GET /modules/{id}/annotations

curl https://api.hub.akuasense.com/v1/modules/1/annotations \
  -H "x-api-key: VOTRE_CLE_API"

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

import requests

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

Réponse

{
  "data": [
    {
      "id": "c98af727-6006-4f97-a498-ffe04b997b93",
      "module_id": 145,
      "probe_id": null,
      "chart_type": "humidity",
      "type": "h-line",
      "p1": [
        1781208270784.069,
        11
      ],
      "p2": [
        1781208270784.069,
        11
      ],
      "unit": "vwc",
      "content": {
        "style": {
          "fill": "threshold2",
          "stroke": "var(--destructive)",
          "lineDash": "dashed",
          "lineWidth": 2
        }
      },
      "user_id": "cmf8x2k4q0002js08h4m2c8kv",
      "created_at": "2026-06-18T19:51:08.446Z",
      "updated_at": "2026-06-18T19:51:29.699Z",
      "style": {
        "fill": "threshold2",
        "stroke": "var(--destructive)",
        "lineDash": "dashed",
        "lineWidth": 2
      }
    },
    {
      "id": "faf982c6-19ae-4844-8d4f-bd143c5a5a46",
      "module_id": 145,
      "probe_id": null,
      "chart_type": "humidity",
      "type": "h-line",
      "p1": [
        1781210832481.468,
        27.69654377924787
      ],
      "p2": [
        1781210832481.468,
        27.69654377924787
      ],
      "unit": "vwc",
      "content": {
        "style": {
          "fill": "threshold1",
          "stroke": "#3b82f6",
          "lineDash": "dashed",
          "lineWidth": 2
        }
      },
      "user_id": "cmf8x2k4q0002js08h4m2c8kv",
      "created_at": "2026-06-18T19:51:42.372Z",
      "updated_at": "2026-07-03T10:01:32.993Z",
      "style": {
        "fill": "threshold1",
        "stroke": "#3b82f6",
        "lineDash": "dashed",
        "lineWidth": 2
      }
    }
  ]
}

application/json

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

application/problem+json · exemple généré depuis le schéma

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

application/problem+json · exemple généré depuis le schéma

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

application/problem+json · exemple généré depuis le schéma