Gate readiness

Reports module

GET/reports/gate-readinessreports.gateReadiness

Criteria with evidence against the next gate of each readable project: blocking and other criteria met and in total, and whether the gate is ready. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability projects.gate.read.
OAuth scopes: projects.
Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

reports.gateReadiness: Path and query parameters
Field	Type	Required	Description
project_id	string (uuid)	No	Only this project; every visible project when omitted.

Response 200: ReportMetricRowPage

reports.gateReadiness: ReportMetricRowPage
Field	Type	Required	Description
data	array of ReportMetricRow	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	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
}

Code samples

curl -X GET "$XOS_BASE_URL/reports/gate-readiness" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

response = xos.reports.gate_readiness()

xos reports gate-readiness