Project Health Reports

Get a project health report

get/project-health-reports/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/project-health-reports/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The project health report uuid

Response

200

idstring

The unique identifier for the object.

datestring date

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

createdAtstring date-time

The timestamp when the object was created.

useBudgetboolean

Whether budget metrics are included in this report.

budgetHealthId'excellent' | 'fair' | 'poor'

The budget health status of the project.

budgetHealthNotesstring nullable

Notes providing details about the budget health.

clientSatisfactionId'excellent' | 'fair' | 'poor'

The client satisfaction level of the project.

clientSatisfactionNotesstring nullable

Notes providing details about client satisfaction.

scheduleHealthId'excellent' | 'fair' | 'poor'

The schedule health status of the project.

scheduleHealthNotesstring nullable

Notes providing details about the schedule health.

teamSatisfactionId'excellent' | 'fair' | 'poor'

The team satisfaction level for the project.

teamSatisfactionNotesstring nullable

Notes providing details about the team's satisfaction.

scorenumber

The overall score for the health report.

billableHoursnumber

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

budgetBillableHoursnumber

The budgeted billable hours for the project.

budgetExpensesCostnumber

The budgeted cost of expenses for the project.

budgetExpensesRevenuenumber

The budgeted revenue from expenses for the project.

budgetInternalHoursnumber nullable

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

budgetNonBillableHoursnumber

The budgeted non-billable hours for the project.

budgetOtherItemsRevenuenumber

The budgeted revenue from other items for the project.

budgetProductItemsRevenuenumber

The budgeted revenue from products for the project.

budgetServicesCostnumber

The budgeted cost of services for the project.

budgetServicesGrossMarginnumber

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

budgetServicesGrossProfitnumber

The budgeted gross profit from services for the project.

budgetServicesRevenuenumber

The budgeted services revenue for the project.

budgetTotalCostnumber

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

budgetTotalGrossMarginnumber

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

budgetTotalGrossProfitnumber

The total budgeted gross profit for the project.

budgetTotalHoursnumber

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

budgetTotalRevenuenumber

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

expensesCostnumber

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

expensesRevenuenumber

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

internalHoursnumber nullable

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

nonBillableHoursnumber

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

otherItemsRevenuenumber

The actual revenue from other items for the project in this period.

productItemsRevenuenumber

The actual revenue from products for the project in this period.

servicesCostnumber

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

servicesGrossMarginnumber

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

servicesGrossProfitnumber

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

servicesRevenuenumber

The actual services revenue for the project in this period.

totalCostnumber

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

totalGrossMarginnumber

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

totalGrossProfitnumber

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

totalHoursnumber

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

totalRevenuenumber

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

notesstring nullable

General commentary for the health report.

Changes

No recorded changes to this operation across all 1 revision of this API.