Santé (batterie, signal, statut)

GET /modules/{id}/health

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

État du BOÎTIER 4G auquel le module est branché : c’est lui qui transmet les mesures.

Paramètres de chemin

id integer obligatoire

Réponse

200

Santé du boîtier, ou null si le module n’est branché sur aucun boîtier

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

Dernière transmission. null : le boîtier n’a encore rien transmis.
id integer toujours présent

Identifiant du boîtier (currentGateway.id du module).
imei string toujours présent
status string toujours présent

faulty : aucune transmission depuis plus de 25 heures.

Valeurs : activefaulty
soc integer peut être null toujours présent

Charge estimée de la batterie, %, déduite de sa tension. null si la tension est inconnue.
charging boolean toujours présent

⚠️ Pas encore alimenté par les boîtiers actuels : vaut false.
level integer peut être null toujours présent

Qualité du signal réseau, en barres, de 0 à 4. null si inconnue.

Erreurs

400
Paramètre invalide

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

GET /modules/{id}/health

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

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

import requests

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

Réponse

{
  "time": "2026-09-11T20:33:03.000Z",
  "id": 191,
  "imei": "DEMO-GW-006",
  "status": "active",
  "soc": 100,
  "charging": false,
  "level": 3
}

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