v1API ReferenceNominal speeds

Create nominal speeds

Required scope: nominal_speeds.create.

Set the expected rate for one or many machine/SKU pairs. The body is a JSON array.

nominalSpeed must be greater than zero, and machine and sku each accept an id or a name. countingFactor defaults to 1 and converts sensor pulses into the SKU's unit — set it to 12 where one pulse means a case of twelve.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A JSON array. Each item has these fields:

Response Body

application/json

application/json

application/json

application/json

application/json

Try it live
POST
/v1/nominal-speeds

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

curl -X POST "https://example.com/v1/nominal-speeds" \  -H "Content-Type: application/json" \  -d '[    {      "nominalSpeed": 60,      "machine": {},      "sku": {}    }  ]'
[  {    "id": "36f7b519-d93e-4ec8-8245-7f4b8c123456",    "machine": {      "id": 1,      "name": "machine 1"    },    "sku": {      "description": "a simple description",      "id": "d87c82e9-0591-4270-abde-d078507cd66b",      "name": "sku 1",      "unit": "units"    },    "nominalSpeed": 100,    "countingFactor": 1,    "createdAt": "2024-01-01T00:00:00.000Z",    "updatedAt": "2024-01-01T00:00:00.000Z",    "deletedAt": "2024-01-02T00:00:00.000Z"  }]

List machines GET

Return every machine the caller's company can see. Machines are the entry point to the rest of the API. Signals take the uuid returned here; production logs, nominal speeds, realtime and reports still take the integer id. uuid is the machine's stable public identifier; it is null for machines that do not have one yet, and those cannot be queried for signals. The list is not paginated and takes no filters — it is scoped to the company resolved from the credential, so there is no company parameter to pass.

Search nominal speeds POST

Search the configured speeds for machine and SKU combinations. Useful for auditing: a machine/SKU pair with no nominal speed, or an obviously wrong one, is the most common cause of a performance figure nobody believes.