# Relatório de paragens (https://docs.pulsarml.com/pt/v1/api-reference/reports/post-reports-stops)

Devolve as paragens individuais das máquinas com a sua duração, causa e classificação.

É o detalhe por trás dos totais de tempo de paragem do relatório de métricas. `stopId` aceita a gramática de comparação completa, por isso é possível obter diretamente uma paragem específica ou um intervalo delas.

## `POST /v1/reports/stops`

Base URLs:
- `https://draco.prod.pulsarml.com` — Produção
- `https://draco.dev.pulsarml.com` — Desenvolvimento (sandbox)

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

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

Type: object (`GetStopsReportRequestV1`)

- `page` (integer, optional, default `1`, > 0, e.g. `1`) — O número da página
- `limit` (integer, optional, default `10`, > 0, e.g. `10`) — O número de elementos por página
- `machines` (object, optional, nullable) — Critérios de filtro para máquinas
  - `search` (string, optional, nullable) — Termo de pesquisa 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
- `stopId` (object, optional, nullable) — Critérios de filtro 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
  - `greaterThan` (number, optional, nullable, e.g. `1`) — Maior do que
  - `greaterThanOrEqual` (number, optional, nullable, e.g. `1`) — Maior ou igual a
  - `lessThan` (number, optional, nullable, e.g. `1`) — Menor do que
  - `lessThanOrEqual` (number, optional, nullable, e.g. `1`) — Menor ou igual a
  - `equal` (number, optional, nullable, e.g. `1`) — Igual a
  - `notEqual` (number, optional, nullable, e.g. `1`) — Diferente de
- `startDate` (object, optional, nullable) — Critérios de filtro para a data de início
  - `after` (string (date-time), optional, nullable) — Filtra por data posterior a
  - `before` (string (date-time), optional, nullable) — Filtra por data anterior a
  - `between` (object, optional, nullable) — Filtra por intervalo de datas
    - `start` (string (date-time), optional, nullable, e.g. `"2024-01-01T00:00:00.000Z"`) — Data de início do intervalo
    - `end` (string (date-time), optional, nullable, e.g. `"2024-01-31T23:59:59.000Z"`) — Data de fim do intervalo
  - `equal` (string (date-time), optional, nullable) — Filtra por data exata
- `endDate` (object, optional, nullable) — Critérios de filtro para a data de fim
  - `after` (string (date-time), optional, nullable) — Filtra por data posterior a
  - `before` (string (date-time), optional, nullable) — Filtra por data anterior a
  - `between` (object, optional, nullable) — Filtra por intervalo de datas
    - `start` (string (date-time), optional, nullable, e.g. `"2024-01-01T00:00:00.000Z"`) — Data de início do intervalo
    - `end` (string (date-time), optional, nullable, e.g. `"2024-01-31T23:59:59.000Z"`) — Data de fim do intervalo
  - `equal` (string (date-time), optional, nullable) — Filtra por data exata

### Responses

#### 200 — Uma página de paragens com a sua causa e classificação

Type: object (`GetStopsReportResponseV1`)

- `totalCount` (integer, optional, default `100`) — O número total de elementos
- `totalPages` (integer, optional, default `10`) — O número total de páginas
- `currentPage` (integer, optional, default `1`) — A página atual
- `stops` (array of object, required)
  - `classification` (object, required) — A classificação da paragem.
    - `id` (integer, required, nullable, e.g. `"9ce2c6b4-a1f4-4bf2-b5c8-10436d1018cc"`) — O identificador único da classificação.
    - `createdAt` (string (date-time), required, nullable, e.g. `"2025-11-01T00:00:00"`) — Data e hora de criação da classificação.
    - `updatedAt` (string (date-time), required, nullable, e.g. `"2025-11-01T00:00:00"`) — Data e hora da última atualização da classificação.
    - `component` (object, required) — O componente associado à paragem.
      - `id` (string (uuid), optional, nullable, e.g. `"aab41200-3db6-49b3-a50a-a873dbef2ba3"`) — O identificador único.
      - `name` (string, optional, nullable, e.g. `"a simple cause"`) — O nome da causa ou do componente.
    - `specificCause` (object, required) — A causa específica da paragem.
      - `id` (string (uuid), optional, nullable, e.g. `"aab41200-3db6-49b3-a50a-a873dbef2ba3"`) — O identificador único.
      - `name` (string, optional, nullable, e.g. `"a simple cause"`) — O nome da causa ou do componente.
    - `generalCause` (object, required) — A causa geral da paragem.
      - `id` (string (uuid), optional, nullable, e.g. `"aab41200-3db6-49b3-a50a-a873dbef2ba3"`) — O identificador único.
      - `name` (string, optional, nullable, e.g. `"a simple cause"`) — O nome da causa ou do componente.
    - `description` (string, optional, nullable, e.g. `"a simple description"`) — Uma descrição da classificação.
  - `company` (object, required) — A empresa associada à paragem.
    - `id` (integer, required, e.g. `1`) — O identificador único da empresa.
    - `name` (string, required, e.g. `"company 1"`) — O nome da empresa.
  - `machine` (object, required) — A máquina da paragem.
    - `id` (integer, required, e.g. `1`) — O identificador único da máquina.
    - `name` (string, required, e.g. `"machine 1"`) — O nome da máquina.
  - `shift` (object, required) — O turno da paragem.
    - `id` (integer, required, e.g. `1`) — O identificador único do turno.
    - `name` (string, required, e.g. `"shift 1"`) — O nome do turno.
    - `startTime` (string (date-time), required, e.g. `"2024-01-01T08:00:00.000Z"`) — A hora de início do turno.
    - `endTime` (string (date-time), required, e.g. `"2024-01-01T16:00:00.000Z"`) — A hora de fim do turno.
    - `isActive` (boolean, required, e.g. `true`) — Se o turno está ativo neste momento.
  - `stop` (object, required) — Informação da paragem.
    - `id` (integer, required, e.g. `1`) — O identificador único da paragem.
    - `startTime` (string (date-time), required, e.g. `"2025-11-01T00:00:00"`) — A hora de início da paragem.
    - `endTime` (string (date-time), required, nullable, e.g. `"2025-11-01T00:00:00"`) — A hora de fim da paragem.
    - `isProgrammed` (boolean, required, e.g. `true`) — Indica se a paragem estava programada.
    - `isIncludedInAvailability` (boolean, required, e.g. `true`) — Indica se a paragem afeta o cálculo da disponibilidade.
    - `isIncludedInStops` (boolean, required, e.g. `true`) — Indica se a paragem conta como paragem de produção.
    - `isManual` (boolean, required, e.g. `true`) — Indica se a paragem foi registada manualmente.
    - `createdAt` (string (date-time), required, nullable, e.g. `"2025-11-01T00:00:00"`) — Data e hora de criação do registo da paragem.
    - `updatedAt` (string (date-time), required, nullable, e.g. `"2025-11-01T00:00:00"`) — Data e hora da última atualização do registo da paragem.
    - `deletedAt` (string (date-time), optional, nullable, e.g. `"2025-11-01T00:00:00"`) — Data e hora de eliminação do registo da paragem, se aplicável.
    - `durationInMinutes` (number, required, e.g. `30`) — A duração da paragem, em minutos.

#### 422 — Erro de validação

Type: object (`HTTPValidationError`)

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

### Example request

```bash
curl -X POST 'https://draco.prod.pulsarml.com/v1/reports/stops' \
  -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"
    },
    "stopId": {
      "equal": 1,
      "exclude": [
        1
      ],
      "greaterThan": 1,
      "greaterThanOrEqual": 1,
      "include": [
        1
      ],
      "lessThan": 1,
      "lessThanOrEqual": 1,
      "notEqual": 1
    }
  }'
```