Read Field
Lire les données d'un seul champ de canal avec HTTP GET
Requête
Méthode HTTP
GET
URL
https://api.thingspeak.com/channels/
<channel_id>
/fields/<field_id>
.<format>
Paramètres d'URL
Nom | Description |
---|---|
| (Obligatoire) ID du canal pour le canal d’intérêt, spécifié sous la forme d'un nombre entier. |
| (Obligatoire) ID de champ pour le canal d’intérêt. |
| (Obligatoire) Format de la réponse HTTP, spécifié comme |
Exemple : https://api.thingspeak.com/channels/266256/fields/2.json
Paramètres de la chaîne de requête
Nom | Description | Type de valeur |
---|---|---|
api_key | (Obligatoire pour les canaux privés) Spécifiez la clé d'API en lecture pour ce canal spécifique. La clé d'API en lecture se trouve dans l'onglet API Keys de la vue des canaux. | chaîne de caractère |
results | (Facultatif) Nombre d'entrées à récupérer. Le nombre maximum est de 8000. | entier |
days | (Facultatif) Nombre de périodes de 24 heures avant maintenant à inclure dans la réponse. La valeur par défaut est 1. | entier |
minutes | (Facultatif) Nombre de périodes de 60 secondes avant maintenant à inclure dans la réponse. La valeur par défaut est 1440. | entier |
start | (Facultatif) Date de début au format AAAA-MM-JJ%20HH:NN:SS. | date-heure |
end | (Facultatif) Date de fin au format AAAA-MM-JJ%20HH:NN:SS. | date-heure |
timezone | (Facultatif) Identifiant du Référence des fuseaux horaires pour cette demande. | chaîne de caractère |
offset | (Facultatif) Décalage du fuseau horaire dans lequel les résultats sont affichés. Utilisez le paramètre de fuseau horaire pour une plus grande précision. | entier |
status | (Facultatif) Incluez les mises à jour de statut dans le flux en définissant "status=true". |
|
metadata | (Facultatif) Incluez les métadonnées d'un canal en définissant "metadata=true". |
|
location | (Facultatif) Incluez la latitude, la longitude et l'altitude dans le flux en définissant "location=true". |
|
min | (Facultatif) Valeur minimale à inclure dans la réponse. |
|
max | (Facultatif) Valeur maximale à inclure dans la réponse. | décimal |
round | (Facultatif) Arrondissez à ce nombre de décimales. | entier |
timescale | (Facultatif) Obtenez la première valeur dans ce nombre de minutes, valeurs valides : 10, 15, 20, 30, 60, 240, 720, 1440, "daily". | entier ou chaîne de caractère |
sum | (Facultatif) Obtenir la somme de ce nombre de minutes, valeurs valides : 10, 15, 20, 30, 60, 240, 720, 1440, "daily". | entier ou chaîne de caractère |
average | (Facultatif) Obtenez la moyenne de ce nombre de minutes, valeurs valides : 10, 15, 20, 30, 60, 240, 720, 1 440, "quotidien". Note: Les valeurs | entier ou chaîne de caractère |
median | (Facultatif) Obtenir la médiane de ce nombre de minutes, valeurs valides : 10, 15, 20, 30, 60, 240, 720, 1 440, "quotidien". | entier ou |
Conseil
Le paramètre results
a la priorité la plus élevée. Utilisation de results
avec les paramètres min
, max
, timescale
, sum
, average
ou median
peuvent entraîner le renvoi de moins de 8 000 enregistrements. Le paramètre results
détermine le nombre maximum d'entrées à utiliser pour une requête, jusqu'à 8 000. Par exemple, considérez un canal avec une mise à jour par minute. Une requête de lecture sur ce canal avec les paramètres ?results=120&sum=60
renvoie uniquement deux enregistrements, et non 120. Voir l'exemple Read Two Hours of Entries in JSON Format and Average.
Exemples
Vous pouvez utiliser votre navigateur Web pour effectuer des requêtes HTTP GET auprès de l'API RESTful pour ThingSpeak™. Pour voir le format d'une réponse HTTP, cliquez sur le lien ou copiez-le dans votre navigateur.
Lire 10 résultats au format JSON
Le canal 9 contient des informations provenant de plusieurs capteurs d'environnement domestique. Vous pouvez lire les données des champs individuels de ce canal public. Le format de la réponse apparaît à la fin de l'URL, avant tout paramètre de la chaîne de requête. Ici le format demandé est json
. Ajoutez le premier paramètre après un point d'interrogation ?
. Vous pouvez utiliser le paramètre de résultats pour contrôler le nombre d'entrées renvoyées, qui peut aller jusqu'à 8 000.
https://api.thingspeak.com/channels/9/fields/1.json?results=10
Lire la valeur médiane toutes les 10 minutes pour 100 résultats au format XML
Dans cet exemple, le format est spécifié en tant que XML. Le paramètre de résultats est utilisé pour renvoyer un nombre spécifié d'entrées, dans ce cas 10.
https://api.thingspeak.com/channels/9/fields/2.xml?results=100&median=10
Lire une plage de dates d'événements au format CSV
Lorsque vous demandez la sortie au format csv
, le fichier renvoyé est un format de variable séparée par des virgules. Selon la configuration de votre ordinateur, votre navigateur peut ouvrir un logiciel supplémentaire pour afficher ce format. Utilisez l'esperluette &
pour ajouter le deuxième paramètre. Dans cet exemple, les paramètres start
et end
sont utilisés pour spécifier des limites de date pour les données demandées.
Lire une journée de résultats au format texte
https://api.thingspeak.com/channels/9/fields/1?api_key=E52AWRAV1RSXQQJW
ThingSpeak renvoie le dernier jour de données, jusqu'à 8 000 points, lorsqu'aucun autre paramètre n'est spécifié.
Réponse
Succès
200 OK
Si vous n'avez pas accès au canal, la réponse est -1.
Erreur
Pour la liste complète, voir Codes d'erreur.
Si vous n'avez pas accès au canal, la réponse est -1.