Admin APIProjects

Get a health report for a project.

Deprecated

This endpoint returns a health report for the specified project. This data is used for the technical debt insights

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

Response

healthReportSchema
versioninteger
The project overview version.
namestring
The project's name
defaultStickinessstring
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
modeenum

The project’s collaboration mode. Determines whether non-project members can submit change requests or not.

Allowed values:
membersinteger>=0

The number of users/members in the project.

technicalDebtdouble0-100

An indicator of the project’s technical debt on a scale from 0 to 100

environmentslist of objects
An array containing the names of all the environments configured for the project.
featureslist of objects
An array containing an overview of all the features of the project and their individual status
potentiallyStaleCountdouble
The number of potentially stale feature flags.
activeCountdouble
The number of active feature flags.
staleCountdouble
The number of stale feature flags.
healthintegerDeprecated

Use technicalDebt instead.

descriptionstring or null
The project's description
featureLimitdouble or null
A limit on the number of features allowed in the project. Null if no limit.
updatedAtstring or nullformat: "date-time"
When the project was last updated.
createdAtstring or nullformat: "date-time"
When the project was last updated.
favoriteboolean or null
Indicates if the project has been marked as a favorite by the current user requesting the project health overview.
statsobject or null
Project statistics
featureNamingobject or null
Create a feature naming pattern

Errors