Project financial health

Returns an aggregated operational summary for a project: budget, margin, burn rate, delivery risk signals, and active alerts. Not a raw data endpoint — designed for dashboards, BI tools, and agents.

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

Authorization

financials:readapi key scoperequired

Required scope when calling with an API key.

project:financial_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/financial-health

curl -X GET "https://www.digitalstack360.com/api/v1/projects/proj_abc123/financial-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",
    "project_name": "Website Replatform",
    "client_name": "Acme Corp",
    "status": "active",
    "health_score": 78,
    "health_status": "watch",
    "financials": {
      "budget_total": 450000,
      "budget_consumed": 182500,
      "budget_remaining": 267500,
      "margin_percent": 34.2,
      "burn_rate_weekly": 21400,
      "forecast_completion_cost": 411000
    },
    "delivery": {
      "timeline_risk": "medium",
      "staffing_risk": "low",
      "scope_risk": "unknown",
      "open_phase_count": 3,
      "completed_phase_count": 1
    },
    "forecast": {
      "estimated_completion_date": "2026-09-14",
      "contract_end_date": "2026-09-30",
      "forecast_confidence": 0.81
    },
    "alerts": [
      {
        "type": "burn_acceleration",
        "severity": "warning",
        "message": "Burn velocity is 18% above planned pace over the last 4 weeks."
      }
    ],
    "updated_at": "2026-05-13T09:00:00.000Z"
  }
}

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