# Reporte de métricas (https://docs.pulsarml.com/es/v1/api-reference/reports/post-reports-metrics)

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.

## `POST /v1/reports/metrics`

Base URLs:
- `https://draco.prod.pulsarml.com` — Producción
- `https://draco.dev.pulsarml.com` — Desarrollo (sandbox)

Authentication: send your API key in the `x-api-key` header.

### Request body (`application/json`, required)

Type: object (`GetMetricsReportRequestV1`)

- `page` (integer, optional, default `1`, > 0, e.g. `1`) — El número de página
- `limit` (integer, optional, default `10`, > 0, e.g. `10`) — La cantidad de elementos por página
- `machines` (object, optional, nullable) — Criterios de filtro para máquinas
  - `search` (string, optional, nullable) — Término de búsqueda para máquinas
  - `include` (array of integer, optional, nullable) — Elementos a incluir, por ID
  - `exclude` (array of integer, optional, nullable) — Elementos a excluir, por ID
- `startDate` (object, optional, nullable) — Criterios de filtro para la fecha de inicio
  - `after` (string (date-time), optional, nullable) — Filtra por fecha posterior a
  - `before` (string (date-time), optional, nullable) — Filtra por fecha anterior a
  - `between` (object, optional, nullable) — Filtra por rango de fechas
    - `start` (string (date-time), optional, nullable, e.g. `"2024-01-01T00:00:00.000Z"`) — Fecha de inicio del rango
    - `end` (string (date-time), optional, nullable, e.g. `"2024-01-31T23:59:59.000Z"`) — Fecha de fin del rango
  - `equal` (string (date-time), optional, nullable) — Filtra por fecha exacta
- `endDate` (object, optional, nullable) — Criterios de filtro para la fecha de fin
  - `after` (string (date-time), optional, nullable) — Filtra por fecha posterior a
  - `before` (string (date-time), optional, nullable) — Filtra por fecha anterior a
  - `between` (object, optional, nullable) — Filtra por rango de fechas
    - `start` (string (date-time), optional, nullable, e.g. `"2024-01-01T00:00:00.000Z"`) — Fecha de inicio del rango
    - `end` (string (date-time), optional, nullable, e.g. `"2024-01-31T23:59:59.000Z"`) — Fecha de fin del rango
  - `equal` (string (date-time), optional, nullable) — Filtra por fecha exacta

### Responses

#### 200 — Una página de métricas por máquina y turno

Type: object (`GetMetricsReportResponseV1`)

- `totalCount` (integer, optional, default `100`) — La cantidad total de elementos
- `totalPages` (integer, optional, default `10`) — La cantidad total de páginas
- `currentPage` (integer, optional, default `1`) — La página actual
- `metrics` (array of object, required)
  - `company` (object, required) — La empresa del reporte de métricas.
    - `id` (integer, required, e.g. `1`) — El identificador único de la empresa.
    - `name` (string, required, e.g. `"company 1"`) — El nombre de la empresa.
  - `machine` (object, required) — La máquina del reporte de métricas.
    - `id` (integer, required, e.g. `1`) — El identificador único de la máquina.
    - `name` (string, required, e.g. `"machine 1"`) — El nombre de la máquina.
  - `shift` (object, required) — El turno del reporte de métricas.
    - `id` (integer, required, e.g. `1`) — El identificador único del turno.
    - `name` (string, required, e.g. `"shift 1"`) — El nombre del turno.
    - `startTime` (string (date-time), required, e.g. `"2024-01-01T08:00:00.000Z"`) — La hora de inicio del turno.
    - `endTime` (string (date-time), required, e.g. `"2024-01-01T16:00:00.000Z"`) — La hora de fin del turno.
    - `isActive` (boolean, required, e.g. `true`) — Si el turno está activo actualmente.
  - `shiftIndicators` (object, required) — Información del indicador del turno.
    - `indicatorId` (integer, optional, nullable, e.g. `1`) — El identificador único del indicador.
    - `annotatedDowntime` (number, optional, nullable, e.g. `0`) — Tiempo muerto anotado, en minutos.
    - `availability` (number, optional, nullable, e.g. `100`) — Porcentaje de disponibilidad.
    - `availableTime` (number, optional, nullable, e.g. `1`) — Tiempo disponible, en minutos.
    - `earlyStopTime` (number, optional, nullable, e.g. `0`) — Tiempo de paro anticipado, en minutos.
    - `lateStartTime` (number, optional, nullable, e.g. `0`) — Tiempo de arranque tardío, en minutos.
    - `netAvailability` (number, optional, nullable, e.g. `100`) — Porcentaje de disponibilidad neta.
    - `noDataTime` (number, optional, nullable, e.g. `0`) — Tiempo sin datos, en minutos.
    - `nonProgrammedDowntime` (number, optional, nullable, e.g. `0`) — Tiempo muerto no programado, en minutos.
    - `programmedDowntime` (number, optional, nullable, e.g. `0`) — Tiempo muerto programado, en minutos.
    - `otherStopsTime` (number, optional, nullable, e.g. `0`) — Tiempo de otros paros, en minutos.
    - `unavailableTime` (number, optional, nullable, e.g. `0`) — Tiempo no disponible, en minutos.
  - `productionMetrics` (object, required) — Información de las métricas de producción.
    - `availability` (number, optional, nullable, e.g. `100`) — Porcentaje de disponibilidad.
    - `netAvailability` (number, optional, nullable, e.g. `100`) — Porcentaje de disponibilidad neta.
    - `oee` (number, optional, nullable, e.g. `100`) — Eficiencia general de los equipos (OEE).
    - `netOee` (number, optional, nullable, e.g. `100`) — OEE neto.
    - `quality` (number, optional, nullable, e.g. `100`) — Porcentaje de calidad.
    - `effectiveness` (number, optional, nullable, e.g. `100`) — Porcentaje de eficiencia.
    - `minutesLostByLowQuality` (number, optional, nullable, e.g. `0`) — Minutos perdidos por baja calidad.
    - `minutesLostByLowSpeed` (number, optional, nullable, e.g. `0`) — Minutos perdidos por baja velocidad.

#### 422 — Error de validación

Type: object (`HTTPValidationError`)

- `detail` (array of object, optional)
  - `loc` (array of string | integer, required)
  - `msg` (string, required)
  - `type` (string, required)

### Example request

```bash
curl -X POST 'https://draco.prod.pulsarml.com/v1/reports/metrics' \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": 1,
    "limit": 10,
    "machines": {
      "exclude": [
        1
      ],
      "include": [
        1
      ],
      "search": "machine 1"
    }
  }'
```