Skip to content
docs

Curve annotations

GET /modules/{id}/annotations
  • Scope annotations:read
  • API key x-api-key
  • Base URL https://api.hub.akuasense.com/v1

Path parameters

  • id integer required

Query parameters

  • chartType string

    Curve whose annotations you want (see AnnotationChartType). tension is still accepted for tensio.

    Values: humidityhumidity-detailhumidity-heatmaptemperaturetensio
    Default: humidity

Response

200

Annotations of the curve, oldest to most recent, all units together: each one carries its unit

  • data array of Annotation always present

    A drawing laid over a hub curve: line, area or text. It belongs to its curve (chart_type) and to the unit it was drawn in (unit). An h-line whose style.fill is threshold1 or threshold2 is an agronomic threshold (field capacity, wilting point), always in vwc; on the humidity curve, the second one arms an alert.

    Show 14 attributes Hide attributes
    • id string uuid always present
    • module_id integer always present
    • probe_id any nullable always present

      Deprecated: always null.

    • chart_type string always present

      Hub curve the annotation belongs to. humidity: the summary curve, weighted moisture — this is the one carrying the agronomic thresholds. humidity-detail: moisture per depth. humidity-heatmap: heat map. temperature: temperature. tensio: tensiometer probe (tension is still accepted on input).

      Values: humidityhumidity-detailhumidity-heatmaptemperaturetensio
    • type string always present

      Shape of the drawing, as the hub’s tools draw it: h-line (horizontal line), v-line (vertical), segment, ray (half-line), infinite (full line), arrow, h-free, rect (area), text. Older annotations carry line.

    • p1 array of any always present

      A point of the curve, [instant, value]: the instant in milliseconds since 1 January 1970 UTC, the value in the annotation’s unit (unit; for moisture, % VWC by default).

    • p2 array of any nullable always present

      Second point, for drawings that have two.

    • unit string nullable always present

      Unit of the points’ height (p1, p2), that is, the view of the curve the annotation belongs to: it is only shown in that unit. humidity and humidity-detail curves only: vwc — volumetric water content, %, the reference unit, the one used by the alert and the water status —, vwc_max — share of soil saturation, % —, mm. null on the other curves, which have a single unit.

      Values: vwcvwc_maxmmnull
    • content object always present

      Style and text of the drawing: { style, text }.

    • user_id string always present

      Author: userId of a member (GET /company/users).

    • created_at string date-time always present
    • updated_at string date-time always present
    • style object

      Copy of content.style, present when there is one.

    • text string

      Copy of content.text, present when there is one.

Errors

  • 400

    Invalid parameter

    invalid_id
  • 401

    Not authenticated

  • 403

    Insufficient scope, or resource outside your company