Incident rates

Módulo Reports

GET/reports/incident-ratesreports.incidentRates

Incidents and open incidents per canon severity, optionally for one project and a window of occurrence. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad safety.incident.read.
Alcances de OAuth: safety.
Estados de error: 400, 401, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

reports.incidentRates: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	No	Only this project; every visible project when omitted.
from	string (date)	No	Occurred on or after this day.
to	string (date)	No	Occurred on or before this day.

Respuesta 200: ReportMetricRowPage

reports.incidentRates: ReportMetricRowPage
Campo	Tipo	Obligatorio	Descripción
data	array of ReportMetricRow	Sí	Items on this page, in the documented default order.
next_cursor	string \| null	Sí	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "dimension": "NWL",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "measure": "worked_hours",
      "unit": "Hours",
      "value": 312.5
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/reports/incident-rates" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.reports.incidentRates();

response = xos.reports.incident_rates()

xos reports incident-rates