v1API ReferenceSignals

Read signal data

Required scope: signals.read.

Return aggregated raw sensor points for one signal.

Samples are bucketed before they are returned. The bucket width is agg_period x agg_unit (agg_period=15, agg_unit=m is a 15-minute bucket) and agg_function is how samples inside a bucket are reduced.

By default points are returned as a data list of {timestamp, value} objects. Pass transpose=true to get two arrays of equal length instead, timestamps and values, where values[i] belongs to timestamps[i]. It carries the same points in a smaller body.

Two limits are enforced and both reject the request rather than truncating the response: the window between start_time and end_time may not exceed 7 days, and a query may not produce more than 12,000 points. The defaults (agg_unit=s, agg_period=1) reach the point ceiling after under three and a half hours, so most callers set them explicitly.

Path Parameters

machine_uuid*string

The machine's uuid, as returned by GET /v1/machines.

Formatuuid
public_id*string

The public ID.

Formatuuid

Query Parameters

start_time*string

Filter by start time.

Formatdate-time
end_time*string

Filter by end time.

Formatdate-time
agg_unit?string

Filter by agg unit.

Default"s"

Value in

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

Filter by agg period.

Range1 <= value
Default1
agg_function?string

Filter by agg function.

Default"avg"

Value in

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

Return parallel timestamps and values arrays instead of a list of {timestamp, value} points.

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

Try it live
GET
/v1/machines/{machine_uuid}/signals/{public_id}

This endpoint requires authentication — paste a token in the Authorization section below.

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    }  ]}

List a machine's signals GET

Return the raw sensor signals a machine exposes, with the public_id needed to read samples. A signal is one sensor channel read by the machine, named after the physical quantity it carries (current, count, product_count, cycle, energy, temperature, pressure, ...). A machine can expose several signals with the same name; their display_name tells them apart. Soft-deleted signals and signals without a kind are not listed. description is in English by default; pass language=es for Spanish. A description with no translation in the requested language is returned in English.

Create work orders POST

Create one or many work orders. The body is a JSON array, even for a single record. Creation is idempotent by name: names are trimmed and de-duplicated, a work order that already exists is returned as-is, and one that was deleted is restored rather than duplicated.