JSON

Sur cette page

La sonde JSON appelle une API, lit une valeur dans la réponse JSON à l'aide d'un JSONPath, et la compare à la valeur attendue. Utilisez-la pour contrôler ce que dit une API, et pas seulement qu'elle répond : l'état d'un composant, la longueur d'une file, une latence rapportée par le service lui-même.

Dans l'assistant : API → JSON response content.

En-tête de Public API — Response time, une sonde JSON : requête GET avec un délai de 10 s, le JSONPath $.p95_ms, la règle « Less than 800 », comparaison insensible à la casse et vérification SSL. — Une sonde JSON lit une valeur par un JSONPath et la compare à une règle, ici la latence p95 de l'API elle-même.

Réglages#

Les réglages de la requête sont ceux de la sonde HTTP (sauf HEAD), plus une section Response validation :

Réglage	Description
JSONPath	Où lire la valeur, par exemple `$.status` ou `$.components[0].state`.
Condition	Comment comparer : Equal to, Not equal to, More than, Less than, Match regex, String contains, conditions sur la longueur d'une chaîne et sur les tableaux (Array contains, Array length equal to…).
Value type	Chaîne, entier, décimal ou date, selon la condition.
Value to check	La valeur attendue.
Case sensitive	Pour les comparaisons de texte.

Quand est-elle saine ?#

Quand la requête réussit avec un code accepté, que le JSONPath trouve une valeur et que la condition est remplie.

La valeur mesurée#

Lorsque la valeur est numérique, elle est enregistrée à chaque contrôle et tracée sur le graphique de la sonde : vous voyez son évolution, et pas seulement un état en service ou en panne. Voir Résultats et historique.

Exemples#

Public API — Response time : $.p95_ms Less than 800. L'API rapporte sa propre latence p95 ; la sonde échoue quand elle dépasse 800 ms.
Notifications — SMS gateway : $.component.status Equal to operational sur l'API de statut du fournisseur.