v1API ReferenceNominal speeds

Search nominal speeds

Required scope: nominal_speeds.read.

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

Try it live
POST
/v1/nominal-speeds/filters

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

curl -X POST "https://example.com/v1/nominal-speeds/filters" \  -H "Content-Type: application/json" \  -d '{}'
{  "totalCount": 100,  "totalPages": 10,  "currentPage": 1,  "nominalSpeeds": [    {      "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"    }  ]}

Create nominal speeds POST

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.

Retrieve a nominal speed GET

Return one nominal-speed record by id.