Read Field
Leer datos de un solo campo de canal con HTTP GET
Pedido
Método HTTP
GET
URL
https://api.thingspeak.com/channels/
<channel_id>
/fields/<field_id>
.<format>
Parámetros de URL
Nombre | Descripción |
---|---|
| (Obligatorio) ID del canal de interés, especificado como un número entero. |
| (Obligatorio) ID de campo para el canal de interés. |
| (Obligatorio) Formato para la respuesta HTTP, especificado como |
Ejemplo: https://api.thingspeak.com/channels/266256/fields/2.json
Parámetros de cadena de consulta
Nombre | Descripción | Tipo de valor |
---|---|---|
api_key | (Obligatorio para canales privados) Especifique Leer clave API para este canal específico. La clave de API de lectura se encuentra en la pestaña API Keys de la vista del canal. | cadena |
results | (Opcional) Número de entradas para recuperar. El número máximo es 8000. | entero |
days | (Opcional) Número de períodos de 24 horas anteriores a ahora para incluir en la respuesta. El valor predeterminado es 1. | entero |
minutes | (Opcional) Número de períodos de 60 segundos anteriores a ahora para incluirlos en la respuesta. El valor predeterminado es 1440. | entero |
start | (Opcional) Fecha de inicio en formato AAAA-MM-DD%20HH:NN:SS. | fecha y hora |
end | (Opcional) Fecha de finalización en formato AAAA-MM-DD%20HH:NN:SS. | fecha y hora |
timezone | (Opcional) Identificador de Referencia de zonas horarias para esta solicitud. | cadena |
offset | (Opcional) Desplazamiento de la zona horaria en la que se muestran los resultados. Utilice el parámetro de zona horaria para mayor precisión. | entero |
status | (Opcional) Incluya actualizaciones de estado en el feed configurando "status=true". |
|
metadata | (Opcional) Incluya metadatos para un canal configurando "metadata=true". |
|
location | (Opcional) Incluya latitud, longitud y elevación en el feed configurando "ubicación=verdadero". |
|
min | (Opcional) Valor mínimo para incluir en la respuesta. |
|
max | (Opcional) Valor máximo para incluir en la respuesta. | decimal |
round | (Opcional) Redondea a esta cantidad de decimales. | entero |
timescale | (Opcional) Obtenga el primer valor en esta cantidad de minutos, valores válidos: 10, 15, 20, 30, 60, 240, 720, 1440, "diario". | entero o cadena |
sum | (Opcional) Obtenga la suma de esta cantidad de minutos, valores válidos: 10, 15, 20, 30, 60, 240, 720, 1440, "diario". | entero o cadena |
average | (Opcional) Obtenga el promedio de esta cantidad de minutos, valores válidos: 10, 15, 20, 30, 60, 240, 720, 1440, "diario". Nota: Los valores | entero o cadena |
median | (Opcional) Obtenga la mediana de esta cantidad de minutos, valores válidos: 10, 15, 20, 30, 60, 240, 720, 1440, "diario". | entero o |
Consejo
El parámetro results
tiene la prioridad más alta. Usando results
con los parámetros min
, max
, timescale
, sum
, average
o median
pueden provocar que se devuelvan menos de 8000 registros. El parámetro results
determina el número máximo de entradas que se utilizarán para una consulta, hasta 8000. Por ejemplo, considere un canal con una actualización por minuto. Una solicitud de lectura a ese canal con los parámetros ?results=120&sum=60
devuelve sólo dos registros, y no 120. Ver el ejemplo Read Two Hours of Entries in JSON Format and Average.
Ejemplos
Puede utilizar su navegador web para completar solicitudes GET HTTP a la API RESTful para ThingSpeak™. Para ver el formato de una respuesta HTTP, haga clic en el enlace o cópielo en su navegador.
Lea 10 resultados en formato JSON
El canal 9 contiene información de varios sensores del entorno doméstico. Puede leer datos de los campos individuales de este canal público. El formato de la respuesta aparece al final de la URL, antes de cualquier parámetro de cadena de consulta. Aquí el formato solicitado es json
. Agregue el primer parámetro después de un signo de interrogación ?
. Puede utilizar el parámetro de resultados para controlar el número de entradas devueltas, que es hasta 8000.
https://api.thingspeak.com/channels/9/fields/1.json?results=10
Lea el valor medio cada 10 minutos para obtener 100 resultados en formato XML
En este ejemplo, el formato se especifica como XML. El parámetro de resultados se utiliza para devolver un número específico de entradas, en este caso 10.
https://api.thingspeak.com/channels/9/fields/2.xml?results=100&median=10
Leer un rango de fechas de eventos en formato CSV
Cuando solicita la salida en formato csv
, el archivo devuelto tiene un formato de variable separado por comas. Dependiendo de la configuración de su computadora, su navegador puede abrir software adicional para mostrar este formato. Utilice el signo comercial &
para agregar el segundo parámetro. En este ejemplo, los parámetros start
y end
se utilizan para especificar límites de fecha para los datos solicitados.
Lea un día de resultados en formato de texto
https://api.thingspeak.com/channels/9/fields/1?api_key=E52AWRAV1RSXQQJW
ThingSpeak devuelve el último día de datos, hasta 8000 puntos, cuando no se especifica ningún otro parámetro.
Respuesta
Éxito
200 OK
Si no tienes acceso al canal, la respuesta es -1.
Error
Para obtener la lista completa, consulte Códigos de error.
Si no tienes acceso al canal, la respuesta es -1.