v1Referencia de la APIReportes

Reporte de paros

Devuelve los paros individuales de las máquinas con su duración, causa y clasificación. Es el detalle detrás de los totales de tiempo muerto del reporte de métricas. stopId acepta la gramática de comparación completa, así que se puede obtener directamente un paro específico o un rango de ellos.

Cuerpo de la solicitud

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

Pruébalo en vivo
POST
/v1/reports/stops

Este endpoint requiere autenticación. Pega un token en la sección Autorización, más abajo.

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"      }    }  ]}

Reporte de métricas POST

Devuelve OEE, disponibilidad, calidad y minutos perdidos por máquina y turno. Cada fila trae los indicadores del turno (tiempo disponible, tiempo muerto separado por causa) junto con las métricas de producción derivadas: `availability`, `effectiveness`, `quality`, `oee` y `netOee`, además de los minutos perdidos por baja velocidad y por baja calidad. Es un `POST` que solo lee: basta con el scope `reports.read`. Es preferible a calcular el OEE a partir de los registros de producción: los límites de turno, la clasificación de paros y los factores de conteo ya están aplicados.

Listar las señales de una máquina GET

Devuelve las señales de sensor en crudo que expone una máquina, con el `public_id` necesario para leer sus muestras. Una señal es un canal de sensor que lee la máquina, nombrado según la magnitud física que transporta (`current`, `count`, `product_count`, `cycle`, `energy`, `temperature`, `pressure`, ...). Una máquina puede exponer varias señales con el mismo `name`; su `display_name` las distingue. No se listan las señales eliminadas ni las que no tienen un tipo. `description` viene en inglés por defecto; pasa `language=es` para obtenerla en español. Una descripción sin traducción al idioma pedido se devuelve en inglés.