Leer datos de una señal

Scope requerido: signals.read.

Devuelve los puntos agregados de una señal de sensor en crudo.

Las muestras se agrupan en intervalos antes de devolverse. El ancho de cada intervalo es agg_period x agg_unit (agg_period=15, agg_unit=m es un intervalo de 15 minutos) y agg_function define cómo se reducen las muestras dentro de un intervalo.

Por defecto los puntos se devuelven como una lista data de objetos {timestamp, value}. Pasa transpose=true para recibir en su lugar dos arreglos de la misma longitud, timestamps y values, donde values[i] corresponde a timestamps[i]. Contiene los mismos puntos en una respuesta más pequeña.

Se aplican dos límites, y ambos rechazan la solicitud en lugar de recortar la respuesta: la ventana entre start_time y end_time no puede superar 7 días, y una consulta no puede producir más de 12,000 puntos. Los valores por defecto (agg_unit=s, agg_period=1) alcanzan el límite de puntos en menos de tres horas y media, así que la mayoría de las llamadas los fijan explícitamente.

Parámetros de ruta

machine_uuid*string

El uuid de la máquina, tal como lo devuelve GET /v1/machines.

Formatouuid
public_id*string

El ID público.

Formatouuid

Parámetros de consulta

start_time*string

Filtra por hora de inicio.

Formatodate-time
end_time*string

Filtra por hora de fin.

Formatodate-time
agg_unit?string

Filtra por unidad de agregación.

Predeterminado"s"

Valor en

  • "s"
  • "m"
  • "h"
  • "d"
agg_period?integer

Filtra por periodo de agregación.

Rango1 <= value
Predeterminado1
agg_function?string

Filtra por función de agregación.

Predeterminado"avg"

Valor en

  • "avg"
  • "max"
  • "min"
  • "sum"
  • "count"
transpose?boolean

Devuelve los arreglos paralelos timestamps y values en lugar de una lista de puntos {timestamp, value}.

Predeterminadofalse

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

Pruébalo en vivo
GET
/v1/machines/{machine_uuid}/signals/{public_id}

Este endpoint requiere autenticación. Pega un token en la sección Autorización, más abajo.

curl -X GET "https://example.com/v1/machines/497f6eca-6276-4993-bfeb-53cbbbba6f08/signals/497f6eca-6276-4993-bfeb-53cbbbba6f08?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z"
{  "machine_uuid": "01748f7c-9688-7abc-8def-0123456789ab",  "public_id": "eb3ce6c7-ce7e-4638-a072-e5054706f601",  "name": "string",  "agg_unit": "s",  "agg_period": 0,  "agg_function": "avg",  "data": [    {      "timestamp": "2019-08-24T14:15:22Z",      "value": 0    }  ]}