Get the home summary

Módulo Home

GET/home/summaryhome.get

Returns the caller's org dashboard: open and blocked work, projects at risk at their next gate, unread alerts and committed spend as a NULL-aware total. A rule that refuses the request returns 422 with `refusal` and `reason`.

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

Respuesta 200: HomeSummary

home.get: HomeSummary
Campo	Tipo	Obligatorio	Descripción
open_work_count	integer	Sí	Records assigned to the caller that are not Complete or Canceled.Restricciones: range 0 to any
blocked_work_count	integer	Sí	Assigned records that are Blocked.Restricciones: range 0 to any
projects_at_risk_count	integer	Sí	Projects with an unsatisfied blocking criterion at the next gate.Restricciones: range 0 to any
alert_count	integer	Sí	Unread alerts.Restricciones: range 0 to any
committed_spend	MoneyTotal	Sí	A money aggregate that never coerces unpriced inputs to zero.

{
  "open_work_count": 7,
  "blocked_work_count": 1,
  "projects_at_risk_count": 2,
  "alert_count": 3,
  "committed_spend": {
    "total_minor": 1250000,
    "currency": "USD",
    "unpriced_count": 2
  }
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/home/summary" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.home.get();

response = xos.home.get()

xos home get