Project health

Returns a one-call advisory health snapshot for a project: delivery status, alerts, phase/workstream progress, execution metrics, and directional financial/staffing signals when the credential is authorized for those sensitive sections.

GET/api/v1/projects/:id/health

Authorization

projects:readapi key scoperequired

Required scope when calling with an API key.

project:delivery_readsession capabilityoptional

Required capability when calling with a signed-in session.

Path parameters

idstringrequired

Project ID

Example: proj_abc123

Request

GET /api/v1/projects/:id/health

curl -X GET "https://www.digitalstack360.com/api/v1/projects/proj_abc123/health" \
  -H "Authorization: Bearer $DS_API_KEY"

Examples use a placeholder key from your environment. Store your key in $DS_API_KEY — never commit it.

Response

200 OK

{
  "data": {
    "project": {
      "id": "proj_abc123",
      "name": "Website Replatform",
      "delivery_status": "at_risk",
      "delivery_risk": "medium"
    },
    "progress": {
      "phases_total": 4,
      "phases_completed": 1,
      "milestones_total": 12,
      "milestones_complete": 7,
      "completion_percent": 58
    },
    "execution": {
      "work_items_total": 240,
      "work_items_done": 141,
      "work_items_active": 99,
      "blocked_items": 8,
      "overdue_items": 12,
      "high_risk_items": 5
    },
    "alerts": [
      {
        "source": "delivery",
        "type": "blocked_items",
        "severity": "warning",
        "message": "8 work items are blocked."
      }
    ],
    "phases": [
      {
        "id": "phase-uuid-1",
        "name": "Discovery",
        "status": "completed",
        "start_date": "2026-01-10",
        "end_date": "2026-02-14"
      }
    ],
    "workstreams": [
      {
        "id": "wstr_abc123",
        "name": "Integrations",
        "status": "at_risk",
        "completion_percent": 54,
        "blocked_items": 3,
        "high_risk_items": 2
      }
    ],
    "financial": {
      "health": "watch",
      "health_score": 78,
      "burn_pct": 41,
      "budget_remaining_pct": 59,
      "timeline_risk": "medium",
      "staffing_risk": "low",
      "scope_risk": "unknown"
    },
    "staffing": {
      "status": "watch",
      "risk": "medium",
      "coverage_percent": 85,
      "open_requests_count": 2,
      "days_until_earliest_gap": 21
    }
  },
  "meta": {
    "truncated": false
  }
}

Errors

401

missing_auth

No credentials provided

401

invalid_api_key

API key is invalid or revoked

403

scope_insufficient

Key lacks projects:read scope

404

not_found

Project not found or not in your workspace