Get a project health report

curl --request GET \
  --url https://www.ruddr.io/api/workspace/project-health-reports/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "a3f8c1d2-7b4e-4f9a-bc12-8e5d3a2f1c90",
  "date": "2026-02-17",
  "createdAt": "2026-02-17T15:20:21.386Z",
  "useBudget": true,
  "budgetHealthId": "excellent",
  "budgetHealthNotes": "Budget is tracking well against plan.",
  "clientSatisfactionId": "excellent",
  "clientSatisfactionNotes": "Client confirmed satisfaction in last steering committee.",
  "scheduleHealthId": "fair",
  "scheduleHealthNotes": "Two milestones slipped by one week.",
  "teamSatisfactionId": "excellent",
  "teamSatisfactionNotes": "Team morale is high after successful sprint.",
  "score": 10,
  "billableHours": 758,
  "budgetBillableHours": 760,
  "budgetExpensesCost": 0,
  "budgetExpensesRevenue": 0,
  "budgetInternalHours": 50,
  "budgetNonBillableHours": 50,
  "budgetServicesCost": 130000,
  "budgetServicesGrossMargin": 0.35,
  "budgetServicesGrossProfit": 70000,
  "budgetServicesRevenue": 200000,
  "budgetTotalCost": 130000,
  "budgetTotalGrossMargin": 0.35,
  "budgetTotalGrossProfit": 70000,
  "budgetTotalHours": 810,
  "budgetTotalRevenue": 200000,
  "expensesCost": 950,
  "expensesRevenue": 950,
  "internalHours": 42,
  "nonBillableHours": 40.5,
  "servicesCost": 102560,
  "servicesGrossMargin": 0.4838,
  "servicesGrossProfit": 96112.8,
  "servicesRevenue": 198672.8,
  "totalCost": 103510,
  "totalGrossMargin": 0.4815,
  "totalGrossProfit": 96112.8,
  "totalHours": 798.5,
  "totalRevenue": 199622.8,
  "notes": "Overall the project is on track with minor schedule concerns.",
  "createdBy": {
    "id": "51a1b20a-8661-4809-be68-ebaa413f7951",
    "name": "Landon Toney"
  },
  "modifiedBy": {
    "id": "51a1b20a-8661-4809-be68-ebaa413f7951",
    "name": "Landon Toney"
  },
  "project": {
    "id": "9f40edff-4975-4d45-9867-aee92921cbc5",
    "name": "HealthPlus - Enterprise Technology Modernization",
    "client": {
      "id": "ab6f38e8-28b2-4c43-8aa6-a04da88d14ca",
      "name": "HealthPlus"
    }
  }
}

GET

project-health-reports

{id}

Get a project health report

curl --request GET \
  --url https://www.ruddr.io/api/workspace/project-health-reports/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "a3f8c1d2-7b4e-4f9a-bc12-8e5d3a2f1c90",
  "date": "2026-02-17",
  "createdAt": "2026-02-17T15:20:21.386Z",
  "useBudget": true,
  "budgetHealthId": "excellent",
  "budgetHealthNotes": "Budget is tracking well against plan.",
  "clientSatisfactionId": "excellent",
  "clientSatisfactionNotes": "Client confirmed satisfaction in last steering committee.",
  "scheduleHealthId": "fair",
  "scheduleHealthNotes": "Two milestones slipped by one week.",
  "teamSatisfactionId": "excellent",
  "teamSatisfactionNotes": "Team morale is high after successful sprint.",
  "score": 10,
  "billableHours": 758,
  "budgetBillableHours": 760,
  "budgetExpensesCost": 0,
  "budgetExpensesRevenue": 0,
  "budgetInternalHours": 50,
  "budgetNonBillableHours": 50,
  "budgetServicesCost": 130000,
  "budgetServicesGrossMargin": 0.35,
  "budgetServicesGrossProfit": 70000,
  "budgetServicesRevenue": 200000,
  "budgetTotalCost": 130000,
  "budgetTotalGrossMargin": 0.35,
  "budgetTotalGrossProfit": 70000,
  "budgetTotalHours": 810,
  "budgetTotalRevenue": 200000,
  "expensesCost": 950,
  "expensesRevenue": 950,
  "internalHours": 42,
  "nonBillableHours": 40.5,
  "servicesCost": 102560,
  "servicesGrossMargin": 0.4838,
  "servicesGrossProfit": 96112.8,
  "servicesRevenue": 198672.8,
  "totalCost": 103510,
  "totalGrossMargin": 0.4815,
  "totalGrossProfit": 96112.8,
  "totalHours": 798.5,
  "totalRevenue": 199622.8,
  "notes": "Overall the project is on track with minor schedule concerns.",
  "createdBy": {
    "id": "51a1b20a-8661-4809-be68-ebaa413f7951",
    "name": "Landon Toney"
  },
  "modifiedBy": {
    "id": "51a1b20a-8661-4809-be68-ebaa413f7951",
    "name": "Landon Toney"
  },
  "project": {
    "id": "9f40edff-4975-4d45-9867-aee92921cbc5",
    "name": "HealthPlus - Enterprise Technology Modernization",
    "client": {
      "id": "ab6f38e8-28b2-4c43-8aa6-a04da88d14ca",
      "name": "HealthPlus"
    }
  }
}

A scorecard for a project’s health with respect to the budget, schedule, client satisfaction, and team satisfaction.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The project health report uuid

Response

200

string

The unique identifier for the object.

date

string<date>

The date of the health report. Will be in the form YYYY-MM-DD.

createdAt

string<date-time>

The timestamp when the object was created.

useBudget

boolean

Whether budget metrics are included in this report.

budgetHealthId

enum<string>

The budget health status of the project. Can be "excellent", "fair", or "poor".

Available options:

excellent,

fair,

poor

budgetHealthNotes

string | null

Notes providing details about the budget health.

clientSatisfactionId

enum<string>

The client satisfaction level of the project. Can be "excellent", "fair", or "poor".

Available options:

excellent,

fair,

poor

clientSatisfactionNotes

string | null

Notes providing details about client satisfaction.

scheduleHealthId

enum<string>

The schedule health status of the project. Can be "excellent", "fair", or "poor".

Available options:

excellent,

fair,

poor

scheduleHealthNotes

string | null

Notes providing details about the schedule health.

teamSatisfactionId

enum<string>

The team satisfaction level for the project. Can be "excellent", "fair", or "poor".

Available options:

excellent,

fair,

poor

teamSatisfactionNotes

string | null

Notes providing details about the team's satisfaction.

score

number

The overall score for the health report.

billableHours

number

The actual billable hours logged against the project in this period.

budgetBillableHours

number

The budgeted billable hours for the project.

budgetExpensesCost

number

The budgeted cost of expenses for the project.

budgetExpensesRevenue

number

The budgeted revenue from expenses for the project.

budgetInternalHours

number | null

The budgeted internal (non-client-facing) hours for the project.

budgetNonBillableHours

number

The budgeted non-billable hours for the project.

budgetServicesCost

number

The budgeted cost of services for the project.

budgetServicesGrossMargin

number

The budgeted gross margin for services, expressed as a decimal (e.g., 0.35 = 35%).

budgetServicesGrossProfit

number

The budgeted gross profit from services for the project.

budgetServicesRevenue

number

The budgeted services revenue for the project.

budgetTotalCost

number

The total budgeted cost for the project (services + expenses).

budgetTotalGrossMargin

number

The total budgeted gross margin for the project, expressed as a decimal (e.g., 0.35 = 35%).

budgetTotalGrossProfit

number

The total budgeted gross profit for the project.

budgetTotalHours

number

The total budgeted hours for the project (billable + non-billable + internal).

budgetTotalRevenue

number

The total budgeted revenue for the project (services + expenses).

expensesCost

number

The actual cost of expenses logged against the project in this period.

expensesRevenue

number

The actual revenue from expenses logged against the project in this period.

internalHours

number | null

The actual internal hours logged against the project in this period.

nonBillableHours

number

The actual non-billable hours logged against the project in this period.

servicesCost

number

The actual cost of services logged against the project in this period.

servicesGrossMargin

number

The actual gross margin for services, expressed as a decimal (e.g., 0.4838 = 48.38%).

servicesGrossProfit

number

The actual gross profit from services for the project in this period.

servicesRevenue

number

The actual services revenue for the project in this period.

totalCost

number

The actual total cost for the project in this period (services + expenses).

totalGrossMargin

number

The actual total gross margin for the project, expressed as a decimal (e.g., 0.4815 = 48.15%).

totalGrossProfit

number

The actual total gross profit for the project in this period.

totalHours

number

The actual total hours logged against the project in this period.

totalRevenue

number

The actual total revenue for the project in this period (services + expenses).

notes

string | null

General commentary for the health report.

createdBy

object

The member who created the record.

Show child attributes

modifiedBy

object

The member who last modified the record.

Show child attributes

project

object

The project this health report belongs to.

Show child attributes

Create a project health report Update a project health report

⌘I

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Get a project health report

Authorizations

Path Parameters

Response