Working with data

Discover machines and sensors#

1. Call GET /api/v1/machines to find available machines. Optional search and status filters narrow the results.
2. Use GET /api/v1/machines/{id}/sensors to discover sensor IDs and metadata.
3. Call GET /api/v1/machines/{id}/snapshot for the latest available sensor values. An optional at timestamp requests a snapshot around a specific instant.

Use identifiers returned by the API, rather than display names, in subsequent requests.

Query historical measurements#

Call the timeseries endpoint with one to eight sensor IDs. Repeat sensor_id for multiple sensors. Replace the example IDs and dates with your own.

curl --get 'https://connect-api.iris-cloud.netzsch.com/api/v1/machines/MACHINE_ID/timeseries' \
  --header "Authorization: Bearer $CONNECT_API_TOKEN" \
  --data-urlencode 'sensor_id=SENSOR_ID' \
  --data-urlencode 'from=2026-09-01T00:00:00Z' \
  --data-urlencode 'to=2026-09-02T00:00:00Z' \
  --data-urlencode 'interval=60000' \
  --data-urlencode 'aggregation=avg' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=100'

• Timestamps: use RFC 3339 UTC timestamps, such as 2026-09-01T00:00:00Z.
• Range: maximum 30 days per query; the default range is the last seven days.
• Interval: a positive bucket size in milliseconds; 60000 is one minute.
• Aggregation: avg, min, max, first or last. Requires interval. With interval alone, buckets return min, max and avg.

Numeric aggregation requires compatible sensor values. The reference describes the exact response format.

Read paginated results#

The timeseries and batch-list endpoints accept page and limit. Pages start at 1; the default page size is 10 and the maximum is 1000.

Read the response’s pagination metadata and request the next page until you have all the results you need. Pagination is endpoint-specific; do not add these parameters to endpoints that do not document them.

Understand alarms and alerts#

Alarms come from the machine’s PLC. Alerts are generated by the platform for machines and sensors. Both endpoints accept from and to, default to the last seven days, and support a maximum 30-day range.

Read production batches#

Use GET /api/v1/batches to list batches. Filter by status, sort by start_time, end_time, batch_id or recipe, and choose ASC or DESC order.

Use an ID from the list with GET /api/v1/batches/{id} to retrieve details. All supported status values and response fields are listed in the API reference.