Live values, charts and range alerts

Besides its status and part counter, a ping can carry up to 20 numbers of your own: an oven temperature, a spindle load, a pressure. What Started calls them metrics. They need a plan with machine metrics.

1. Send the numbers

Add them to the ping you already send, under custom:

{ "status": "run", "cycleCount": 1200, "custom": { "oven_temp": 192.4, "fan_rpm": 1460 } }

Machines that can only send a GET request use custom.<name>=<number>:

GET /api/v1/ping?token=hbp_…&status=run&custom.oven_temp=192.4

Names use lowercase letters, digits and _, start with a letter and are at most 40 characters. Use the same name on every machine for the same thing; the settings below apply to the name across your plant.

2. Watch them live

Open a machine. Live values shows the latest value of each metric the moment a ping arrives, with how long ago it came. A value outside its normal range is red. A value the machine has stopped sending turns grey after about three missed pings.

Under it, History charts each metric over the last hour, 24 hours or 7 days. The line is the average, the shaded band runs from the lowest to the highest value, and dashed red lines mark the normal range. A break in the line means the machine sent nothing for a while.

Charts use the values What Started stores, at most one per ping interval of your plan. Live values update on every ping.

3. Name them and set a normal range

Open Settings → Metrics. Every name a machine has sent is listed, with its latest values. For each one you can set:

Setting	What it does
Name	What people see instead of oven_temp, for example "Oven temp"
Unit	Shown after the value, for example °C or rpm
Decimals	How many decimals to show, 0 to 4
Normal low	Values below it are out of range. Leave empty for no lower end
Normal high	Values above it are out of range. Leave empty for no upper end
Alert	Email owners and admins when a value leaves the range
Pin	Show the value on the board and TV tiles

Only owners and admins can change settings.

4. Range alerts

With Alert on, What Started checks every value as it arrives. When one is outside the normal range, it opens an alert for that machine and metric and emails your owners and admins with the value and the range. The alert closes when a value inside the range comes in.

A value that hovers right at a limit can go in and out many times. You get at most one email per machine and metric every 30 minutes; the alerts list and webhooks still show each one.

Changing the range or turning the alert off closes open alerts for that metric. If the value is still outside, the next ping opens a new one.

5. Pin them to the board

Turn on Pin for up to three metrics. Each board and TV tile then shows them under the part counts, live, in red when out of range.

From other systems

• GET /api/v1/machines includes the live values of every machine.
• Range alerts come out of GET /api/v1/alerts and the alert.opened and alert.resolved webhooks with kind metric_range, the metric's name and the value that opened them.