Aller au contenu
docs

Lister les alertes de la société

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

Paramètres de requête

  • cursor string

    Curseur de pagination opaque

  • limit integer
    Par défaut : 50
  • lang string

    Langue des label, et du nom par défaut d’une sonde (name : « Probe 3 », « Sonde 3 »). Les code ne varient jamais. Une culture sans traduction retombe sur son nom français.

    Valeurs : enfr
    Par défaut : en

Réponse

200

Alertes, de la plus récente à la plus ancienne

  • data tableau d’AlertListItem toujours présent

    Seuil d’alerte sur l’humidité de la courbe de synthèse d’un module. Sous threshold, l’alerte se déclenche : un e-mail part aux destinataires, puis un rappel chaque jour à reminderTime tant qu’elle n’est ni résolue ni acquittée. Elle se résout quand l’humidité remonte à threshold + hysteresis.

    Afficher les 17 attributs Masquer les attributs
    • id string uuid toujours présent
    • companyId integer toujours présent
    • moduleId integer peut être null toujours présent

      Module surveillé.

    • parcelId integer peut être null toujours présent

      Parcelle. ⚠️ Seules les mesures d’un module sont évaluées : une alerte sans moduleId ne se déclenche jamais.

    • annotationId string uuid peut être null toujours présent

      Ligne « point de flétrissement » dont l’alerte est née (source: annotation). Déplacer la ligne déplace le seuil ; la supprimer désactive l’alerte.

    • threshold string toujours présent

      Nombre décimal transmis en CHAÎNE, sans perte de précision ("11", "25.5625") : à convertir côté client.

    • hysteresis string toujours présent

      Nombre décimal transmis en CHAÎNE, sans perte de précision ("11", "25.5625") : à convertir côté client.

    • reminderTime string toujours présent

      Heure LOCALE du rappel quotidien (HH:MM:SS), dans le fuseau de la société (timezone de GET /company).

    • source string toujours présent

      manual : créée directement (POST /alerts). annotation : née d’une ligne « point de flétrissement ».

      Valeurs : manualannotation
    • isActive boolean toujours présent

      false : désactivée, plus évaluée.

    • createdBy string toujours présent

      Créateur : userId d’un membre.

    • createdAt string date-time toujours présent
    • updatedAt string date-time toujours présent
    • events tableau d’AlertEvent toujours présent

      Les 10 derniers événements, du plus récent au plus ancien. Historique complet : GET /alerts/{id}/events.

      Afficher les 9 attributs Masquer les attributs
      • id string uuid toujours présent
      • alertId string uuid toujours présent
      • type string toujours présent

        triggered : l’humidité est passée sous le seuil. resolved : elle est remontée au seuil plus l’hystérésis.

        Valeurs : triggeredresolved
      • valueAtEvent string toujours présent

        Humidité mesurée à cet instant, %.

      • thresholdAtEvent string toujours présent

        Seuil en vigueur à cet instant, %.

      • occurredAt string date-time toujours présent
      • emailSent boolean toujours présent

        L’e-mail de cet événement est parti.

      • acknowledgedAt string date-time peut être null toujours présent

        Acquittement (POST /alerts/{id}/ack) : les rappels cessent. null : non acquitté.

      • acknowledgedBy string peut être null toujours présent

        Qui a acquitté : userId d’un membre.

    • recipients tableau d’object toujours présent
      Afficher les 4 attributs Masquer les attributs
      • id string uuid toujours présent
      • alertId string uuid toujours présent
      • userId string toujours présent

        Destinataire des e-mails : userId d’un membre.

      • user object toujours présent
        Afficher les 5 attributs Masquer les attributs
        • id string toujours présent
        • name string peut être null toujours présent
        • lastName string peut être null toujours présent
        • email string email toujours présent
        • image string peut être null toujours présent

          URL de l’avatar.

    • parcel object peut être null toujours présent
      Afficher les 2 attributs Masquer les attributs
      • id integer toujours présent
      • name string toujours présent
    • module object peut être null toujours présent
      Afficher les 4 attributs Masquer les attributs
      • id integer toujours présent
      • uid string toujours présent
      • name string peut être null toujours présent

        Nom de la sonde, comme sur Module ; le nom par défaut suit lang.

      • serialHex string peut être null toujours présent
  • next_cursor string peut être null toujours présent

    Curseur de la page suivante, à repasser tel quel dans cursor. null : dernière page.

Erreurs

  • 401

    Non authentifié

  • 403

    Scope insuffisant ou ressource hors société