v1API ReferenceReports

Stops report

Return individual machine stops with their duration, cause and classification. This is the drill-down behind the downtime totals in the metrics report. stopId accepts the full comparison grammar, so a specific stop or a range of them can be pulled directly.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

Try it live
POST
/v1/reports/stops

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

curl -X POST "https://example.com/v1/reports/stops" \  -H "Content-Type: application/json" \  -d '{}'
{  "totalCount": 100,  "totalPages": 10,  "currentPage": 1,  "stops": [    {      "classification": {        "component": {          "id": "5e9f21d1-3a93-4a36-8f6e-44b9bd7ed305",          "name": "a simple component"        },        "createdAt": "2025-11-01T00:00:00",        "description": "a simple description",        "generalCause": {          "id": "96066d06-c3de-4bdc-987d-1db1ccf30550",          "name": "a simple general cause"        },        "id": 1,        "specificCause": {          "id": "08d9f0e7-3aaf-4afe-a2d0-0bb113b214e0",          "name": "a simple specific cause"        },        "updatedAt": "2025-11-01T00:00:00"      },      "company": {        "id": 1,        "name": "a simple company"      },      "machine": {        "id": 1,        "name": "a simple machine"      },      "shift": {        "endTime": "2025-11-10T00:00:00",        "id": 1,        "isActive": true,        "name": "morning",        "startTime": "2025-11-01T00:00:00"      },      "stop": {        "createdAt": "2025-11-01T00:00:00",        "deletedAt": "2025-11-10T00:00:00",        "durationInMinutes": 30,        "endTime": "2025-11-10T00:00:00",        "id": 1,        "isIncludedInAvailability": true,        "isIncludedInStops": true,        "isManual": true,        "isProgrammed": true,        "startTime": "2025-11-01T00:00:00",        "updatedAt": "2025-11-01T00:00:00"      }    }  ]}

Metrics report POST

Return OEE, availability, quality and lost minutes per machine and shift. Each row carries the shift indicators (available time, downtime split by cause) together with the derived production metrics: `availability`, `effectiveness`, `quality`, `oee` and `netOee`, plus minutes lost to low speed and to low quality. A `POST` that only reads — the `reports.read` scope is sufficient. Prefer this over deriving OEE from production logs: shift boundaries, downtime classification and counting factors are already applied.

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.